High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
feat: backups (#32268)
Paul Makles177b57b689be
diff --git a/e2e/src/specs/maintenance/server/futo-backups.e2e-spec.ts b/e2e/src/specs/maintenance/server/futo-backups.e2e-spec.tsnew file mode 100644index 0000000000..3e5a6d115f--- /dev/null+++ b/e2e/src/specs/maintenance/server/futo-backups.e2e-spec.ts@@ -0,0 +1,384 @@+import * as sdk from '@immich/sdk';+import { LoginResponseDto, StorageFolder } from '@immich/sdk';+import { io, Socket } from 'socket.io-client';+import { createUserDto } from 'src/fixtures';+import { app, asBearerAuth, baseUrl, utils } from 'src/utils';+import request from 'supertest';+import { afterAll, beforeAll, describe, expect, it } from 'vitest';++describe('/futo-backups', () => {+ let admin: LoginResponseDto;+ let nonAdmin: LoginResponseDto;+ let requestOpts: any;+ let filename: string;++ let socket: Socket;+ let libraryId: string;++ beforeAll(async () => {+ utils.initSdk();++ await utils.resetDatabase();+ admin = await utils.adminSetup();+ nonAdmin = await utils.userSetup(admin.accessToken, createUserDto.user1);++ requestOpts = { headers: asBearerAuth(admin.accessToken) };++ await utils.resetBackups(admin.accessToken);+ await sdk.futoBackupsResetOrchestrator(requestOpts);++ socket = io(baseUrl, {+ path: '/api/futo-backups/socket.io',+ transports: ['websocket'],+ extraHeaders: asBearerAuth(admin.accessToken),+ });++ socket.onAny(console.info);+ });++ afterAll(async () => {+ socket.close();++ // trigger update for orchestrator module config+ if (libraryId) {+ await utils.deleteLibrary(admin.accessToken, libraryId);+ }+ });++ const finishedJobStatuses = new Set(['complete', 'warn', 'failed', 'cancelled', 'incomplete']);++ const waitForMessage = (type: string, matches: (payload: any) => boolean = () => true) => {+ return new Promise((resolve) => {+ const listener = (msg: string) => {+ const payload = JSON.parse(msg);+ if (payload.type !== type || !matches(payload)) {+ return;+ }++ resolve(payload);+ socket.offAny(listener);+ };++ socket.onAny(listener);+ });+ };++ describe('Orchestration Module', async () => {+ it('works', async () => {+ await expect(sdk.futoBackupsOnboardingStatus(requestOpts)).resolves.toEqual(+ expect.objectContaining({+ hasOnboardedKey: false,+ hasBackend: false,+ hasBackup: false,+ hasSchedule: false,+ hasSkippedExtraConfig: false,+ }),+ );+ });++ it('is inaccessible without admin', async () => {+ await expect(sdk.futoBackupsOnboardingStatus({ headers: asBearerAuth(nonAdmin.accessToken) })).rejects.toEqual(+ expect.objectContaining({ data: { message: expect.any(String) } }),+ );+ });++ it('is inaccessible without logging in', async () => {+ await expect(sdk.futoBackupsOnboardingStatus()).rejects.toEqual(+ expect.objectContaining({ data: { message: 'Authentication required' } }),+ );+ });+ });++ describe('Local Backup', { concurrent: false }, async () => {+ beforeAll(async () => {+ await sdk.futoBackupsImportRecoveryKey(+ {+ importRecoveryKeyRequest: {+ recoveryKey: '0'.repeat(64),+ },+ },+ requestOpts,+ );+ });++ it('configures a local backend', { concurrent: false }, async () => {+ await utils.mkFolder('/local-backend');++ await sdk.futoBackupsCreateLocalBackend(+ {+ createLocalBackendRequestDto: {+ path: '/local-backend',+ },+ },+ requestOpts,+ );+ });++ it('configures Immich backup', { concurrent: false }, async () => {+ const event = waitForMessage('IntegrationUpdate');++ await sdk.futoBackupsConfigureImmichIntegration(+ {+ configureImmichIntegrationRequestDto: {+ name: 'Immich',+ worm: false,+ cron: '0 3 * * *',+ backupConfiguration: true,+ dataFolders: [StorageFolder.Backups, StorageFolder.Upload],+ libraries: ['all'],+ },+ },+ requestOpts,+ );++ await event;++ await expect(sdk.futoBackupsGetIntegrations(requestOpts)).resolves.toEqual(+ expect.objectContaining({+ immichIntegration: expect.objectContaining({+ configuration: {+ backupConfiguration: true,+ dataFolders: ['backups', 'upload'],+ libraries: ['all'],+ },+ }),+ immichState: {+ dataFolders: expect.arrayContaining(Object.values(StorageFolder)),+ dataPath: '/data',+ // may have stale libraries from other test runs+ libraries: expect.any(Array),+ },+ }),+ );+ });++ it('updates configuration', { concurrent: false }, async () => {+ await utils.mkFolder('/test');++ ({ id: libraryId } = await utils.createLibrary(admin.accessToken, {+ ownerId: admin.userId,+ name: 'My Library',+ importPaths: ['/test'],+ }));++ await expect(sdk.futoBackupsGetIntegrations(requestOpts)).resolves.toEqual(+ expect.objectContaining({+ immichIntegration: expect.any(Object),+ immichState: expect.objectContaining({+ libraries: expect.arrayContaining([+ expect.objectContaining({+ name: 'My Library',+ importPaths: ['/test'],+ }),+ ]),+ }),+ }),+ );+ });++ it('creates a snapshot', { concurrent: false }, async () => {+ const event = waitForMessage('JobUpdate', ({ job }) => finishedJobStatuses.has(job?.status));++ const { repositories } = await sdk.futoBackupsGetRepositories(requestOpts);+ const { id } = repositories[0];++ filename = await utils.createBackup(admin.accessToken);++ await sdk.futoBackupsCreateBackup({ id }, requestOpts);+ await event;++ const { snapshots } = await sdk.futoBackupsGetSnapshots({ id }, requestOpts);+ const { id: snapshotId } = snapshots[0];++ await expect(sdk.futoBackupsGetSnapshotListing({ id, snapshot: snapshotId }, requestOpts)).resolves+ .toMatchInlineSnapshot(`+ {+ "items": [+ {+ "isDirectory": true,+ "path": "/data",+ },+ {+ "isDirectory": true,+ "path": "/test",+ },+ ],+ "parent": "/",+ "path": "/",+ }+ `);++ await expect(sdk.futoBackupsGetSnapshotListing({ id, snapshot: snapshotId, path: '/data' }, requestOpts)).resolves+ .toMatchInlineSnapshot(`+ {+ "items": [+ {+ "isDirectory": true,+ "path": "/data/backups",+ },+ {+ "isDirectory": true,+ "path": "/data/upload",+ },+ ],+ "parent": "/",+ "path": "/data",+ }+ `);++ await expect(+ sdk.futoBackupsGetSnapshotListing({ id, snapshot: snapshotId, path: '/data/backups' }, requestOpts),+ ).resolves.toEqual(+ expect.objectContaining({+ items: expect.arrayContaining([+ { isDirectory: false, path: '/data/backups/.immich' },+ { isDirectory: false, path: `/data/backups/${filename}` },+ { isDirectory: true, path: '/data/backups/yucca' },+ ]),+ parent: '/data',+ path: '/data/backups',+ }),+ );+ });+ });++ describe('Restore Local Backup', { concurrent: false }, async () => {+ let cookie: string;++ beforeAll(async () => {+ await sdk.futoBackupsResetOrchestrator(requestOpts);+ await utils.resetDatabase();+ socket.disconnect();+ await utils.disconnectDatabase();+ });++ afterAll(async () => {+ await utils.connectDatabase();+ });++ it('restores backup', { timeout: 60_000, concurrent: false }, async () => {+ const { status, headers } = await request(app).post('/admin/database-backups/start-restore').send();+ expect(status).toBe(201);+ cookie = headers['set-cookie'][0].split(';', 1)[0];++ await expect+ .poll(+ async () => {+ const { status, body } = await request(app).get('/server/config');+ expect(status).toBe(200);+ return body.maintenanceMode;+ },+ {+ interval: 500,+ timeout: 10_000,+ },+ )+ .toBeTruthy();++ const maintenanceRequestOpts = {+ headers: {+ cookie,+ },+ };++ await expect(sdk.futoBackupsGetSchedules(maintenanceRequestOpts)).resolves.toEqual({ schedules: [] });++ await sdk.futoBackupsImportRecoveryKey(+ {+ importRecoveryKeyRequest: {+ recoveryKey: '0'.repeat(64),+ },+ },+ maintenanceRequestOpts,+ );++ const {+ backend: { id: backendId },+ } = await sdk.futoBackupsCreateLocalBackend(+ {+ createLocalBackendRequestDto: {+ path: '/local-backend',+ },+ },+ maintenanceRequestOpts,+ );++ const { repositories } = await sdk.futoBackupsInspectRepositories({}, maintenanceRequestOpts);+ const { id: repositoryId, snapshots } = repositories[0];+ const { id: snapshotId } = (snapshots ?? [])[0];++ socket = io(baseUrl, {+ path: '/api/futo-backups/socket.io',+ transports: ['websocket'],+ extraHeaders: {+ cookie,+ },+ });++ const event = waitForMessage('JobUpdate', ({ job }) => finishedJobStatuses.has(job?.status));+ await sdk.futoBackupsRestoreFromPoint(+ {+ id: repositoryId,+ snapshot: snapshotId,+ backend: backendId,+ repositorySnapshotRestoreFromPointRequestDto: {+ yuccaConfig: '/data/yucca',+ include: ['/data'],+ },+ },+ maintenanceRequestOpts,+ );++ await event;+ socket.disconnect();++ const { status: restoreStatus } = await request(app).post('/admin/maintenance').set('Cookie', cookie).send({+ action: 'restore_database',+ restoreBackupFilename: filename,+ });++ expect(restoreStatus).toBe(201);++ await expect+ .poll(+ async () => {+ const { status, body } = await request(app).get('/server/config');+ expect(status).toBe(200);+ return body.maintenanceMode;+ },+ {+ interval: 500,+ timeout: 10_000,+ },+ )+ .toBeTruthy();++ const { status: status2, body } = await request(app).get('/admin/maintenance/status');+ expect(status2).toBe(200);+ expect(body).toEqual(+ expect.objectContaining({+ active: true,+ action: 'restore_database',+ }),+ );++ await expect+ .poll(+ async () => {+ const { status, body } = await request(app).get('/server/config');+ expect(status).toBe(200);+ return body.maintenanceMode;+ },+ {+ interval: 500,+ timeout: 60_000,+ },+ )+ .toBeFalsy();++ await expect(sdk.futoBackupsGetSchedules(requestOpts)).resolves.toEqual({+ schedules: expect.arrayContaining([expect.objectContaining({ id: expect.any(String) })]),+ });+ });+ });+});diff --git a/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts b/e2e/src/specs/maintenance/web/database-backups.e2e-spec.tsindex efcf2ef27d..6503343607 100644--- a/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts+++ b/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts@@ -95,6 +95,7 @@ test.describe('Database Backups', () => {await page.waitForURL('/maintenance**');}+ await page.getByRole('button', { name: 'Database Backup' }).click();await page.getByRole('button', { name: 'Next' }).click();await page.getByRole('button', { name: 'Restore', exact: true }).click();await page.getByRole('dialog').getByRole('button', { name: 'Restore' }).click();diff --git a/e2e/src/specs/maintenance/web/futo-backups.e2e-spec.ts b/e2e/src/specs/maintenance/web/futo-backups.e2e-spec.tsnew file mode 100644index 0000000000..590b111a7c--- /dev/null+++ b/e2e/src/specs/maintenance/web/futo-backups.e2e-spec.ts@@ -0,0 +1,173 @@+import * as sdk from '@immich/sdk';+import { LoginResponseDto, StorageFolder, getServerFeatures } from '@immich/sdk';+import { expect, test } from '@playwright/test';+import { io, type Socket } from 'socket.io-client';+import { asBearerAuth, baseUrl, utils } from 'src/utils';++test.describe.configure({ mode: 'serial' });++test.describe('FUTO Backups', () => {+ let admin: LoginResponseDto;+ let socket: Socket;++ const finishedJobStatuses = new Set(['complete', 'warn', 'failed', 'cancelled', 'incomplete']);++ const waitForJobEnd = () =>+ new Promise<void>((resolve) => {+ const listener = (msg: string) => {+ try {+ const payload = JSON.parse(msg);+ if (payload.type === 'JobUpdate' && finishedJobStatuses.has(payload.job?.status)) {+ socket.offAny(listener);+ resolve();+ }+ } catch {+ // no-op+ }+ };+ socket.onAny(listener);+ });++ test.beforeAll(async () => {+ utils.initSdk();+ await utils.resetDatabase();+ admin = await utils.adminSetup();++ const headers = asBearerAuth(admin.accessToken);+ await sdk.futoBackupsResetOrchestrator({ headers });+ await sdk.futoBackupsImportRecoveryKey({ importRecoveryKeyRequest: { recoveryKey: '0'.repeat(64) } }, { headers });+ await sdk.futoBackupsConfirmRecoveryKey({ headers });+ await sdk.futoBackupsEnableTelemetry({ headers });+ await utils.mkFolder('/local-backend');++ socket = io(baseUrl, {+ path: '/api/futo-backups/socket.io',+ transports: ['websocket'],+ extraHeaders: headers,+ forceNew: true,+ });+ await new Promise<void>((resolve) => socket.on('connect', () => resolve()));+ });++ test.afterAll(async () => {+ socket?.close();+ });++ test('the backups link opens the upsell before backups are configured', async ({ context, page }) => {+ const headers = asBearerAuth(admin.accessToken);+ await utils.setAuthCookies(context, admin.accessToken);++ await expect(getServerFeatures({ headers })).resolves.toMatchObject({ backups: false });++ await page.goto('/link?target=backups');+ await page.waitForURL('/admin/backups');++ await expect(page.getByRole('heading', { name: 'FUTO Backups', exact: true })).toBeVisible();+ await expect(page.getByRole('button', { name: 'Get Started' })).toBeVisible();+ await expect(page.getByRole('link', { name: 'Set up Backups' })).toBeVisible();+ await expect(getServerFeatures({ headers })).resolves.toMatchObject({ backups: true });+ });++ test('the backups link opens the dashboard once backups are configured', async ({ context, page }) => {+ test.setTimeout(60_000);+ const headers = asBearerAuth(admin.accessToken);+ await utils.setAuthCookies(context, admin.accessToken);++ await sdk.futoBackupsCreateLocalBackend({ createLocalBackendRequestDto: { path: '/local-backend' } }, { headers });+ await sdk.futoBackupsConfigureImmichIntegration(+ {+ configureImmichIntegrationRequestDto: {+ name: 'Immich',+ worm: false,+ cron: '0 3 * * *',+ backupConfiguration: true,+ dataFolders: [StorageFolder.Backups, StorageFolder.Upload],+ libraries: ['all'],+ },+ },+ { headers },+ );++ const { repositories } = await sdk.futoBackupsGetRepositories({ headers });+ const backupEnd = waitForJobEnd();+ await sdk.futoBackupsCreateBackup({ id: repositories[0].id }, { headers });+ await backupEnd;++ await page.goto('/link?target=backups');+ await page.waitForURL('/admin/backups');++ await expect(page.getByText('Your library backup')).toBeVisible();+ await expect(page.getByText('Last backup successful')).toBeVisible();+ });++ test('manually triggers a backup and waits for completion', async ({ context, page }) => {+ test.setTimeout(60_000);+ await utils.setAuthCookies(context, admin.accessToken);++ await page.goto('/admin/backups');+ await page.getByRole('button', { name: 'Back up now', exact: true }).click();++ const dialog = page.getByRole('dialog');+ await expect(dialog.getByRole('heading', { name: 'Backing up your library' })).toBeVisible();+ await expect(dialog.getByRole('heading', { name: 'Backup complete' })).toBeVisible({ timeout: 45_000 });+ });++ test('resets immich and restores from the local FUTO Backups backup', async ({ context, page }) => {+ test.setTimeout(120_000);+ await utils.setAuthCookies(context, admin.accessToken);++ await utils.resetBackups(admin.accessToken);+ await utils.createBackup(admin.accessToken);++ await sdk.futoBackupsResetOrchestrator({ headers: asBearerAuth(admin.accessToken) });+ await utils.resetDatabase();++ await page.goto('/');+ await page.getByRole('button', { name: 'Restore from backup' }).click();++ try {+ await page.waitForURL('/maintenance**');+ } catch {+ await page.goto('/maintenance');+ await page.waitForURL('/maintenance**');+ }++ await page.getByRole('button', { name: 'FUTO Backups' }).click();++ const dialog = page.getByRole('dialog');+ await expect(dialog.filter({ hasText: 'Telemetry required for closed beta' })).toBeVisible();+ await dialog.getByRole('button', { name: 'Continue' }).click();++ await expect(dialog.filter({ hasText: 'Import recovery key' })).toBeVisible();+ await dialog.getByLabel('Recovery Key').fill('0'.repeat(64));+ await dialog.getByRole('button', { name: 'Save' }).click();++ await expect(dialog.filter({ hasText: 'Where would you like to restore from?' })).toBeVisible();+ await dialog.getByText('Local Storage').click();++ await expect(dialog.filter({ hasText: 'Create local backend' })).toBeVisible();+ await dialog.getByLabel('Path').fill('/local-backend');+ await dialog.getByRole('button', { name: 'Save' }).click();++ await expect(dialog.filter({ hasText: 'Select Backup' })).toBeVisible();+ await dialog+ .getByRole('button', { name: /Last backup/ })+ .first()+ .click();++ await expect(dialog.filter({ hasText: /Restore from/ })).toBeVisible();+ await dialog.getByRole('button', { name: 'Restore' }).first().click();++ await expect(dialog.filter({ hasText: 'Confirm restore from snapshot' })).toBeVisible();+ await dialog.getByRole('button', { name: 'Restore', exact: true }).click();++ await expect(dialog.filter({ hasText: 'Restoring' })).toBeVisible();+ await expect(dialog.filter({ hasText: 'Restoring' })).toBeHidden({ timeout: 60_000 });++ await page.getByRole('button', { name: 'Continue' }).click();+ await page.getByRole('dialog').getByRole('button', { name: 'Restore' }).click();++ await page.waitForURL('/maintenance?**');+ await page.waitForURL('/photos', { timeout: 90_000 });+ });+});diff --git a/e2e/src/specs/server/api/server.e2e-spec.ts b/e2e/src/specs/server/api/server.e2e-spec.tsindex 48d2b2c6d9..bc301c4d4f 100644--- a/e2e/src/specs/server/api/server.e2e-spec.ts+++ b/e2e/src/specs/server/api/server.e2e-spec.ts@@ -98,6 +98,7 @@ describe('/server', () => {configFile: false,duplicateDetection: false,facialRecognition: false,+ backups: false,map: true,reverseGeocoding: true,importFaces: false,diff --git a/e2e/src/ui/mock-network/base-network.ts b/e2e/src/ui/mock-network/base-network.tsindex 3c761ba371..65d2e48896 100644--- a/e2e/src/ui/mock-network/base-network.ts+++ b/e2e/src/ui/mock-network/base-network.ts@@ -143,6 +143,7 @@ export const setupBaseMockApiRoutes = async (context: BrowserContext, adminUserIsmartSearch: false,facialRecognition: false,duplicateDetection: false,+ backups: false,map: true,reverseGeocoding: true,importFaces: false,diff --git a/e2e/src/utils.ts b/e2e/src/utils.tsindex 02cce09835..6f32a64234 100644--- a/e2e/src/utils.ts+++ b/e2e/src/utils.ts@@ -31,6 +31,7 @@ import {createUserAdmin,deleteAssets,deleteDatabaseBackup,+ deleteLibrary,getAssetInfo,getConfig,getConfigDefaults,@@ -466,6 +467,8 @@ export const utils = {updateLibrary: (accessToken: string, id: string, dto: UpdateLibraryDto) =>updateLibrary({ id, updateLibraryDto: dto }, { headers: asBearerAuth(accessToken) }),+ deleteLibrary: (accessToken: string, id: string) => deleteLibrary({ id }, { headers: asBearerAuth(accessToken) }),+createPartner: (accessToken: string, id: string) =>createPartner({ partnerCreateDto: { sharedWithId: id } }, { headers: asBearerAuth(accessToken) }),diff --git a/i18n/en.json b/i18n/en.jsonindex 17209e5d81..bb64a20cf1 100644--- a/i18n/en.json+++ b/i18n/en.json@@ -61,6 +61,12 @@"backup_onboarding_title": "Backups","backup_settings": "Database Dump Settings","backup_settings_description": "Manage database dump settings.",+ "backups": "Backups",+ "backups_attempts": "Backup attempts",+ "backups_hide_reminder": "Hide backups reminder",+ "backups_hide_reminder_description": "If you already manage backups outside of Immich, you can hide the backup setup reminder.",+ "backups_settings": "Backup settings",+ "backups_snapshots": "Snapshots","cleared_jobs": "Cleared jobs for: {job}","config_set_by_file": "Config is currently set by a config file","confirm_delete_library": "Are you sure you want to delete {library} library?",@@ -1022,6 +1028,7 @@"failed_to_keep_this_delete_others": "Failed to keep this asset and delete the other assets","failed_to_load_asset": "Failed to load asset","failed_to_load_assets": "Failed to load assets",+ "failed_to_load_database_backups": "Failed to load database backups","failed_to_load_notifications": "Failed to load notifications","failed_to_load_people": "Failed to load people","failed_to_remove_product_key": "Failed to remove product key",@@ -1383,10 +1390,12 @@"main_branch_warning": "You're using a development version; we strongly recommend using a release version!","main_menu": "Main menu","maintenance_action_restore": "Restoring Database",+ "maintenance_action_rollback": "Restoring from Backup","maintenance_description": "Immich has been put into <link>maintenance mode</link>.","maintenance_end": "End maintenance mode","maintenance_logged_in_as": "Currently logged in as {user}","maintenance_restore_from_backup": "Restore From Backup",+ "maintenance_restore_latest_backup_description": "We'll restore your database from the most recent backup. You can also pick a different one.","maintenance_restore_library": "Restore Your Library","maintenance_restore_library_confirm": "If this looks correct, continue to restoring a backup!","maintenance_restore_library_description": "Restoring Database",@@ -1399,6 +1408,13 @@"maintenance_restore_library_hint_regenerate_later": "You can regenerate these later in settings","maintenance_restore_library_hint_storage_template_missing_files": "Using storage template? You may be missing files","maintenance_restore_library_loading": "Loading integrity checks and heuristics…",+ "maintenance_restore_loading_backups": "Loading backups…",+ "maintenance_restore_no_backups": "There are no database backups.",+ "maintenance_restore_select_another": "Select another backup",+ "maintenance_restore_source_database_backup": "Database Backup",+ "maintenance_restore_source_futo_backups": "FUTO Backups",+ "maintenance_restore_source_title": "Where would you like to restore from?",+ "maintenance_restore_upload_backup": "Upload a backup","maintenance_task_backup": "Creating a backup of the existing database…","maintenance_task_migrations": "Running database migrations…","maintenance_task_restore": "Restoring the chosen backup…",@@ -1771,6 +1787,8 @@"purchase_panel_title": "Support the project","purchase_per_server": "Per server","purchase_per_user": "Per user",+ "purchase_product_key_description": "Product keys support Immich development and give you a supporter badge.",+ "purchase_product_key_excludes_backups": "Product keys do not include FUTO Backups.","purchase_remove_product_key": "Remove Product Key","purchase_remove_product_key_prompt": "Are you sure you want to remove the product key?","purchase_remove_server_product_key": "Remove Server product key",diff --git a/mise.lock b/mise.lockindex a53d473e6f..03c8a613eb 100644--- a/mise.lock+++ b/mise.lock@@ -289,6 +289,45 @@ url = "https://github.com/pnpm/pnpm/releases/download/v12.15.0/pnpm-win32-x64.ziurl_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/662173351"provenance = "github-attestations"+[[tools.restic]]+version = "0.19.0"+backend = "aqua:restic/restic"++[tools.restic."platforms.linux-arm64"]+checksum = "sha256:e522ce6bf748d753fee8093e8ec59359972cf5b6bc65fc7c7cf38ae952351d91"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_linux_arm64.bz2"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442897888"++[tools.restic."platforms.linux-arm64-musl"]+checksum = "sha256:e522ce6bf748d753fee8093e8ec59359972cf5b6bc65fc7c7cf38ae952351d91"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_linux_arm64.bz2"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442897888"++[tools.restic."platforms.linux-x64"]+checksum = "sha256:13176fe6d89d4357947a2cd107218ab2873a5f9d8e1ac2d4cd1c8e07e6839c21"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_linux_amd64.bz2"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442897993"++[tools.restic."platforms.linux-x64-musl"]+checksum = "sha256:13176fe6d89d4357947a2cd107218ab2873a5f9d8e1ac2d4cd1c8e07e6839c21"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_linux_amd64.bz2"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442897993"++[tools.restic."platforms.macos-arm64"]+checksum = "sha256:1475397bf759ef4be16a77b19dec650bdbfec00d2cacd82005553411cdd37997"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_darwin_arm64.bz2"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442898395"++[tools.restic."platforms.macos-x64"]+checksum = "sha256:c9d9a71234bc0955fdba6da93cc9375f8793ec1e1cbce77a91014d536a969148"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_darwin_amd64.bz2"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442898462"++[tools.restic."platforms.windows-x64"]+checksum = "sha256:6fa4219a70b1b5d1c429bb106a7f97f3d2a5aab74494db2e490b625edc486d8f"+url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_windows_amd64.zip"+url_api = "https://api.github.com/repos/restic/restic/releases/assets/442897166"+[[tools.terragrunt]]version = "1.2.0"backend = "aqua:gruntwork-io/terragrunt"diff --git a/mise.toml b/mise.tomlindex 9dd63e653c..97ab58cfb9 100644--- a/mise.toml+++ b/mise.toml@@ -25,6 +25,7 @@ opentofu = "1.13.2""github:extism/cli" = "1.6.3""github:webassembly/binaryen" = "version_124""github:extism/js-pdk" = "v1.7.0"+restic = "0.19.0"java = "21.0.2"[tools."github:jellyfin/jellyfin-ffmpeg"]diff --git a/mobile/lib/utils/openapi_patching.dart b/mobile/lib/utils/openapi_patching.dartindex df926028db..65e086f40d 100644--- a/mobile/lib/utils/openapi_patching.dart+++ b/mobile/lib/utils/openapi_patching.dart@@ -48,7 +48,7 @@ final Map<String, Map<String, Object?>> openApiPatches = {'LoginResponseDto': {'isOnboarded': false},'SyncUserV1': {'profileChangedAt': _now, 'hasProfileImage': false},'SyncAssetV1': {'isEdited': false},- 'ServerFeaturesDto': {'ocr': false, 'realtimeTranscoding': false},+ 'ServerFeaturesDto': {'ocr': false, 'realtimeTranscoding': false, 'backups': false},'SearchAssetResponseDto': {'nextCursor': null},'MemoriesResponse': {'duration': 5, 'sidebarWeb': false},'PeopleResponse': {'updateStrategy': 'everyone'},diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.jsonindex 8d18513dc9..713f7c8286 100644--- a/open-api/immich-openapi-specs.json+++ b/open-api/immich-openapi-specs.json@@ -7219,18 +7219,17 @@"x-immich-state": "Stable"}},- "/jobs": {+ "/futo-backups/auth/oidc/device": {"get": {- "deprecated": true,- "description": "Retrieve the counts of the current queue, as well as the current status.",- "operationId": "getQueuesLegacy",+ "description": "Connect an existing FUTO Backups account to this server.",+ "operationId": "futoBackupsConnectDeviceFlow","parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/QueuesResponseLegacyDto"+ "$ref": "#/components/schemas/DeviceFlowEventDto"}}},@@ -7248,49 +7247,41 @@"api_key": []}],- "summary": "Retrieve queue counts and status",+ "summary": "Connect a FUTO Backups account","tags": [- "Jobs",- "Deprecated"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"- },- {- "version": "v2.4.0",- "state": "Deprecated"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "job.read",- "x-immich-state": "Deprecated"- },+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/auth/session": {"post": {- "description": "Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.",- "operationId": "createJob",+ "description": "Use existing session token to create a session on your device.",+ "operationId": "futoBackupsCreateSession","parameters": [],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/JobCreateDto"+ "$ref": "#/components/schemas/CreateSessionRequestDto"}}},"required": true},"responses": {- "204": {+ "201": {"description": ""}},@@ -7305,60 +7296,35 @@"api_key": []}],- "summary": "Create a manual job",+ "summary": "Create session","tags": [- "Jobs"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "job.create",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/jobs/{name}": {- "put": {- "deprecated": true,- "description": "Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.",- "operationId": "runQueueCommandLegacy",- "parameters": [- {- "name": "name",- "required": true,- "in": "path",- "schema": {- "$ref": "#/components/schemas/QueueName"- }- }- ],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/QueueCommandDto"- }- }- },- "required": true- },+ "/futo-backups/auth/session/device": {+ "get": {+ "description": "Log into standalone backups app using the associated cloud account.",+ "operationId": "futoBackupsSessionDeviceFlow",+ "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/QueueResponseLegacyDto"+ "$ref": "#/components/schemas/DeviceFlowEventDto"}}},@@ -7376,48 +7342,45 @@"api_key": []}],- "summary": "Run jobs",+ "summary": "Sign in with FUTO Backups account","tags": [- "Jobs",- "Deprecated"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"- },- {- "version": "v2.4.0",- "state": "Deprecated"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "job.create",- "x-immich-state": "Deprecated"+ "x-immich-state": "Internal"}},- "/libraries": {- "get": {- "description": "Retrieve a list of external libraries.",- "operationId": "getAllLibraries",+ "/futo-backups/auth/ticket": {+ "post": {+ "description": "Create a ticket to perform a protected repository action.",+ "operationId": "futoBackupsCreateTicket","parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/TicketCreateRequestDto"+ }+ }+ },+ "required": true+ },"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/LibraryResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/TicketCreateResponseDto"}}},@@ -7435,48 +7398,35 @@"api_key": []}],- "summary": "Retrieve libraries",+ "summary": "Create a ticket","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.read",- "x-immich-state": "Stable"- },- "post": {- "description": "Create a new external library.",- "operationId": "createLibrary",+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/backend": {+ "get": {+ "description": "List the storage backends configured on this server.",+ "operationId": "futoBackupsGetBackends","parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/CreateLibraryDto"- }- }- },- "required": true- },"responses": {- "201": {+ "200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/LibraryResponseDto"+ "$ref": "#/components/schemas/BackendsResponseDto"}}},@@ -7494,47 +7444,48 @@"api_key": []}],- "summary": "Create a library",+ "summary": "List backends","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.create",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/libraries/{id}": {- "delete": {- "description": "Delete an external library by its ID.",- "operationId": "deleteLibrary",- "parameters": [- {- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"+ "/futo-backups/backend/local": {+ "post": {+ "description": "Add a storage backend that writes to a local path on this server.",+ "operationId": "futoBackupsCreateLocalBackend",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/CreateLocalBackendRequestDto"+ }}- }- ],+ },+ "required": true+ },"responses": {- "204": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/BackendResponseDto"+ }+ }+ },"description": ""}},@@ -7549,49 +7500,35 @@"api_key": []}],- "summary": "Delete a library",+ "summary": "Create a local backend","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.delete",- "x-immich-state": "Stable"- },+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/config": {"get": {- "description": "Retrieve an external library by its ID.",- "operationId": "getLibrary",- "parameters": [- {- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }- }- ],+ "description": "Retrieve the current backups orchestrator configuration.",+ "operationId": "futoBackupsGetConfig",+ "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/LibraryResponseDto"+ "$ref": "#/components/schemas/ConfigResponseDto"}}},@@ -7609,48 +7546,32 @@"api_key": []}],- "summary": "Retrieve a library",+ "summary": "Get backups orchestrator configuration","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.read",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"},"put": {- "description": "Update an existing external library.",- "operationId": "updateLibrary",- "parameters": [- {- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }- }- ],+ "description": "Update the backups orchestrator configuration.",+ "operationId": "futoBackupsUpdateConfig",+ "parameters": [],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/UpdateLibraryDto"+ "$ref": "#/components/schemas/ConfigUpdateRequestDto"}}},@@ -7661,7 +7582,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/LibraryResponseDto"+ "$ref": "#/components/schemas/ConfigResponseDto"}}},@@ -7679,52 +7600,31 @@"api_key": []}],- "summary": "Update a library",+ "summary": "Update backups orchestrator configuration","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"- },- {- "version": "v3.0.0",- "state": "Updated",- "description": "This endpoint now also supports PATCH, in addition to PUT. PATCH will become the default in v4, and then PUT will be dropped in v5. Please migrate accordingly."+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.update",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/libraries/{id}/scan": {+ "/futo-backups/debug/reset": {"post": {- "description": "Queue a scan for the external library to find and import new assets.",- "operationId": "scanLibrary",- "parameters": [- {- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }- }- ],+ "description": "Delete all orchestrator state. Only available in development mode.",+ "operationId": "futoBackupsResetOrchestrator",+ "parameters": [],"responses": {- "204": {+ "201": {"description": ""}},@@ -7739,41 +7639,34 @@"api_key": []}],- "summary": "Scan a library",+ "summary": "Reset the backups orchestrator","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.update",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/libraries/{id}/statistics": {+ "/futo-backups/fs": {"get": {- "description": "Retrieve statistics for a specific external library, including number of videos, images, and storage usage.",- "operationId": "getLibraryStatistics",+ "description": "List the files and folders at a path on this server.",+ "operationId": "futoBackupsGetFileListing","parameters": [{- "name": "id",- "required": true,- "in": "path",+ "name": "path",+ "required": false,+ "in": "query","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}@@ -7783,7 +7676,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/LibraryStatsResponseDto"+ "$ref": "#/components/schemas/FilesystemListingResponseDto"}}},@@ -7801,61 +7694,35 @@"api_key": []}],- "summary": "Retrieve library statistics",+ "summary": "List files","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "library.statistics",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/libraries/{id}/validate": {- "post": {- "description": "Validate the settings of an external library.",- "operationId": "validate",- "parameters": [- {- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }- }- ],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/ValidateLibraryDto"- }- }- },- "required": true- },+ "/futo-backups/integrations": {+ "get": {+ "description": "Retrieve the configuration and state of each integration.",+ "operationId": "futoBackupsGetIntegrations",+ "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/ValidateLibraryResponseDto"+ "$ref": "#/components/schemas/IntegrationsResponseDto"}}},@@ -7873,103 +7740,45 @@"api_key": []}],- "summary": "Validate library settings",+ "summary": "Get backup integrations","tags": [- "Libraries"+ "Backups"],"x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/map/markers": {- "get": {- "description": "Retrieve a list of latitude and longitude coordinates for every asset with location data.",- "operationId": "getMapMarkers",- "parameters": [- {- "name": "fileCreatedAfter",- "required": false,- "in": "query",- "description": "Filter assets created after this date",- "schema": {- "format": "date-time",- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",- "example": "2024-01-01T00:00:00.000Z",- "type": "string"- }- },- {- "name": "fileCreatedBefore",- "required": false,- "in": "query",- "description": "Filter assets created before this date",- "schema": {- "format": "date-time",- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",- "example": "2024-01-01T00:00:00.000Z",- "type": "string"- }- },- {- "name": "isArchived",- "required": false,- "in": "query",- "description": "Filter by archived status",- "schema": {- "type": "boolean"- }- },- {- "name": "isFavorite",- "required": false,- "in": "query",- "description": "Filter by favorite status",- "schema": {- "type": "boolean"- }- },- {- "name": "withPartners",- "required": false,- "in": "query",- "description": "Include partner assets",- "schema": {- "type": "boolean"+ "/futo-backups/integrations/immich": {+ "post": {+ "description": "Set up backups for the Immich backup integration.",+ "operationId": "futoBackupsConfigureImmichIntegration",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ConfigureImmichIntegrationRequestDto"+ }}},- {- "name": "withSharedAlbums",- "required": false,- "in": "query",- "description": "Include shared album assets",- "schema": {- "type": "boolean"- }- }- ],+ "required": true+ },"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/MapMarkerResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/ConfigureImmichIntegrationResponseDto"}}},@@ -7987,66 +7796,41 @@"api_key": []}],- "summary": "Retrieve map markers",+ "summary": "Configure the Immich backup integration","tags": [- "Map"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "map.read",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/map/reverse-geocode": {- "get": {- "description": "Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.",- "operationId": "reverseGeocode",- "parameters": [- {- "name": "lat",- "required": true,- "in": "query",- "description": "Latitude (-90 to 90)",- "schema": {- "format": "double",- "type": "number"+ "/futo-backups/integrations/immich/database-dump": {+ "post": {+ "description": "Configure the Immich database dumps included in backups.",+ "operationId": "futoBackupsConfigureImmichDatabaseDump",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ConfigureImmichDatabaseDumpRequestDto"+ }}},- {- "name": "lon",- "required": true,- "in": "query",- "description": "Longitude (-180 to 180)",- "schema": {- "format": "double",- "type": "number"- }- }- ],+ "required": true+ },"responses": {- "200": {- "content": {- "application/json": {- "schema": {- "items": {- "$ref": "#/components/schemas/MapReverseGeocodeResponseDto"- },- "type": "array"- }- }- },+ "201": {"description": ""}},@@ -8061,131 +7845,123 @@"api_key": []}],- "summary": "Reverse geocode coordinates",+ "summary": "Configure Immich database dumps","tags": [- "Map"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "map.search",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/memories": {- "get": {- "description": "Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly.",- "operationId": "searchMemories",- "parameters": [+ "/futo-backups/integrations/immich/database-dump/ignore-warning": {+ "post": {+ "description": "Stop warning that Immich database dumps are not configured.",+ "operationId": "futoBackupsIgnoreImmichDatabaseDumpWarning",+ "parameters": [],+ "responses": {+ "201": {+ "description": ""+ }+ },+ "security": [{- "name": "for",- "required": false,- "in": "query",- "description": "Filter by date",- "schema": {- "format": "date",- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",- "example": "2024-01-01",- "type": "string"- }+ "bearer": []},{- "name": "id",- "required": false,- "in": "query",- "description": "Memory ID",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }+ "cookie": []},{- "name": "isSaved",- "required": false,- "in": "query",- "description": "Filter by saved status",- "schema": {- "type": "boolean"- }- },+ "api_key": []+ }+ ],+ "summary": "Ignore the Immich database dump warning",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [{- "name": "isTrashed",- "required": false,- "in": "query",- "description": "Include trashed memories",- "schema": {- "type": "boolean"- }+ "version": "v3.4.0",+ "state": "Added"},{- "name": "isUpcoming",- "required": false,- "in": "query",- "description": "Filter by memories that have not been shown yet",- "schema": {- "type": "boolean"+ "version": "v3.4.0",+ "state": "Internal"+ }+ ],+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/integrations/immich/rollback": {+ "post": {+ "description": "Put Immich into maintenance mode and restore it from a snapshot.",+ "operationId": "futoBackupsStartImmichRollback",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ImmichRollbackRequestDto"+ }}},+ "required": true+ },+ "responses": {+ "201": {+ "description": ""+ }+ },+ "security": [{- "name": "order",- "required": false,- "in": "query",- "schema": {- "$ref": "#/components/schemas/MemorySearchOrder"- }+ "bearer": []},{- "name": "page",- "required": false,- "in": "query",- "description": "Page number",- "schema": {- "minimum": 1,- "maximum": 9007199254740991,- "type": "integer"- }+ "cookie": []},{- "name": "size",- "required": false,- "in": "query",- "description": "Number of memories to return",- "schema": {- "minimum": 1,- "maximum": 9007199254740991,- "type": "integer"- }+ "api_key": []+ }+ ],+ "summary": "Roll Immich back to a snapshot",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v3.4.0",+ "state": "Added"},{- "name": "type",- "required": false,- "in": "query",- "schema": {- "$ref": "#/components/schemas/MemoryType"- }+ "version": "v3.4.0",+ "state": "Internal"}],+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/integrations/immich/status": {+ "get": {+ "description": "Retrieve the backup status of the Immich integration.",+ "operationId": "futoBackupsGetImmichBackupStatus",+ "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/MemoryResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/ImmichBackupStatusDto"}}},@@ -8203,47 +7979,44 @@"api_key": []}],- "summary": "Retrieve memories",+ "summary": "Get Immich backup status","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "memory.read",- "x-immich-state": "Stable"- },- "post": {- "description": "Create a new memory by providing a name, description, and a list of asset IDs to include in the memory.",- "operationId": "createMemory",- "parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/MemoryCreateDto"- }+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/jobs": {+ "get": {+ "description": "List the jobs for a repository, newest first.",+ "operationId": "futoBackupsGetJobs",+ "parameters": [+ {+ "name": "repositoryId",+ "required": true,+ "in": "query",+ "schema": {+ "type": "string"}- },- "required": true- },+ }+ ],"responses": {- "201": {+ "200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/MemoryResponseDto"+ "$ref": "#/components/schemas/JobListResponseDto"}}},@@ -8261,119 +8034,81 @@"api_key": []}],- "summary": "Create a memory",+ "summary": "List jobs","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "memory.create",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/memories/statistics": {- "get": {- "description": "Retrieve statistics about memories, such as total count and other relevant metrics.",- "operationId": "memoriesStatistics",+ "/futo-backups/jobs/{id}": {+ "delete": {+ "description": "Cancel a queued job, or stop it if it is already running.",+ "operationId": "futoBackupsCancelJob","parameters": [- {- "name": "for",- "required": false,- "in": "query",- "description": "Filter by date",- "schema": {- "format": "date",- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",- "example": "2024-01-01",- "type": "string"- }- },{"name": "id",- "required": false,- "in": "query",- "description": "Memory ID",+ "required": true,+ "in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}+ }+ ],+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []},{- "name": "isSaved",- "required": false,- "in": "query",- "description": "Filter by saved status",- "schema": {- "type": "boolean"- }+ "cookie": []},{- "name": "isTrashed",- "required": false,- "in": "query",- "description": "Include trashed memories",- "schema": {- "type": "boolean"- }+ "api_key": []+ }+ ],+ "summary": "Cancel a job",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v3.4.0",+ "state": "Added"},{- "name": "isUpcoming",- "required": false,- "in": "query",- "description": "Filter by memories that have not been shown yet",- "schema": {- "type": "boolean"- }- },- {- "name": "order",- "required": false,- "in": "query",- "schema": {- "$ref": "#/components/schemas/MemorySearchOrder"- }- },- {- "name": "page",- "required": false,- "in": "query",- "description": "Page number",- "schema": {- "minimum": 1,- "maximum": 9007199254740991,- "type": "integer"- }- },- {- "name": "size",- "required": false,- "in": "query",- "description": "Number of memories to return",- "schema": {- "minimum": 1,- "maximum": 9007199254740991,- "type": "integer"- }- },+ "version": "v3.4.0",+ "state": "Internal"+ }+ ],+ "x-immich-state": "Internal"+ },+ "get": {+ "description": "Get the status of a job.",+ "operationId": "futoBackupsGetJob",+ "parameters": [{- "name": "type",- "required": false,- "in": "query",+ "name": "id",+ "required": true,+ "in": "path","schema": {- "$ref": "#/components/schemas/MemoryType"+ "type": "string"}}],@@ -8382,7 +8117,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/MemoryStatisticsResponseDto"+ "$ref": "#/components/schemas/JobDto"}}},@@ -8400,46 +8135,48 @@"api_key": []}],- "summary": "Retrieve memories statistics",+ "summary": "Get a job","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "memory.statistics",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/memories/{id}": {- "delete": {- "description": "Delete a specific memory by its ID.",- "operationId": "deleteMemory",+ "/futo-backups/jobs/{id}/download": {+ "get": {+ "description": "Download the full log of a job as JSON lines.",+ "operationId": "futoBackupsDownloadJobLog","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}],"responses": {- "204": {+ "200": {+ "content": {+ "application/jsonl": {+ "schema": {+ "format": "binary",+ "type": "string"+ }+ }+ },"description": ""}},@@ -8454,38 +8191,34 @@"api_key": []}],- "summary": "Delete a memory",+ "summary": "Download a job log","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "memory.delete",- "x-immich-state": "Stable"- },+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/jobs/{id}/support-log/download": {"get": {- "description": "Retrieve a specific memory by its ID.",- "operationId": "getMemory",+ "description": "Download the verbose restic output recorded while the job ran in support mode, as JSON lines.",+ "operationId": "futoBackupsDownloadJobSupportLog","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}@@ -8493,9 +8226,10 @@"responses": {"200": {"content": {- "application/json": {+ "application/jsonl": {"schema": {- "$ref": "#/components/schemas/MemoryResponseDto"+ "format": "binary",+ "type": "string"}}},@@ -8513,58 +8247,81 @@"api_key": []}],- "summary": "Retrieve a memory",+ "summary": "Download a job support log","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"+ "version": "v3.4.0",+ "state": "Internal"+ }+ ],+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/onboarding": {+ "get": {+ "description": "Retrieve which onboarding steps this server has completed.",+ "operationId": "futoBackupsOnboardingStatus",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/OnboardingStatusResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []},{- "version": "v2",- "state": "Stable"+ "cookie": []+ },+ {+ "api_key": []}],- "x-immich-permission": "memory.read",- "x-immich-state": "Stable"- },- "put": {- "description": "Update an existing memory by its ID.",- "operationId": "updateMemory",- "parameters": [+ "summary": "Get backup onboarding status",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [{- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }+ "version": "v3.4.0",+ "state": "Added"+ },+ {+ "version": "v3.4.0",+ "state": "Internal"}],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/MemoryUpdateDto"- }- }- },- "required": true- },+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/onboarding/recovery-key": {+ "get": {+ "description": "Retrieve the recovery key that encrypts the backups of this server.",+ "operationId": "futoBackupsCurrentRecoveryKey",+ "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/MemoryResponseDto"+ "$ref": "#/components/schemas/CurrentRecoveryKeyResponse"}}},@@ -8582,54 +8339,69 @@"api_key": []}],- "summary": "Update a memory",+ "summary": "Get the backup recovery key","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"+ "version": "v3.4.0",+ "state": "Internal"+ }+ ],+ "x-immich-state": "Internal"+ },+ "post": {+ "description": "Record that the user has saved the recovery key.",+ "operationId": "futoBackupsConfirmRecoveryKey",+ "parameters": [],+ "responses": {+ "201": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []},{- "version": "v2",- "state": "Stable"+ "cookie": []},{- "version": "v3.0.0",- "state": "Updated",- "description": "This endpoint now also supports PATCH, in addition to PUT. PATCH will become the default in v4, and then PUT will be dropped in v5. Please migrate accordingly."+ "api_key": []}],- "x-immich-permission": "memory.update",- "x-immich-state": "Stable"- }- },- "/memories/{id}/assets": {- "delete": {- "description": "Remove a list of asset IDs from a specific memory.",- "operationId": "removeMemoryAssets",- "parameters": [+ "summary": "Confirm the backup recovery key",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [{- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }+ "version": "v3.4.0",+ "state": "Added"+ },+ {+ "version": "v3.4.0",+ "state": "Internal"}],+ "x-immich-state": "Internal"+ },+ "put": {+ "description": "Replace the recovery key with one from an earlier installation.",+ "operationId": "futoBackupsImportRecoveryKey",+ "parameters": [],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/BulkIdsDto"+ "$ref": "#/components/schemas/ImportRecoveryKeyRequest"}}},@@ -8637,16 +8409,6 @@},"responses": {"200": {- "content": {- "application/json": {- "schema": {- "items": {- "$ref": "#/components/schemas/BulkIdResponseDto"- },- "type": "array"- }- }- },"description": ""}},@@ -8661,64 +8423,31 @@"api_key": []}],- "summary": "Remove assets from a memory",+ "summary": "Import a backup recovery key","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"- }- ],- "x-immich-permission": "memoryAsset.delete",- "x-immich-state": "Stable"- },- "put": {- "description": "Add a list of asset IDs to a specific memory.",- "operationId": "addMemoryAssets",- "parameters": [- {- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }+ "version": "v3.4.0",+ "state": "Internal"}],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/BulkIdsDto"- }- }- },- "required": true- },+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/onboarding/report-error": {+ "post": {+ "description": "Send the current startup error to telemetry.",+ "operationId": "futoBackupsReportError",+ "parameters": [],"responses": {- "200": {- "content": {- "application/json": {- "schema": {- "items": {- "$ref": "#/components/schemas/BulkIdResponseDto"- },- "type": "array"- }- }- },+ "201": {"description": ""}},@@ -8733,45 +8462,31 @@"api_key": []}],- "summary": "Add assets to a memory",+ "summary": "Report a startup error","tags": [- "Memories"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "memoryAsset.create",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/notifications": {- "delete": {- "description": "Delete a list of notifications at once.",- "operationId": "deleteNotifications",+ "/futo-backups/onboarding/skip": {+ "post": {+ "description": "Skip the optional configuration steps of onboarding.",+ "operationId": "futoBackupsSkipOnboardingExtraConfig","parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/NotificationDeleteAllDto"- }- }- },- "required": true- },"responses": {- "204": {+ "201": {"description": ""}},@@ -8786,77 +8501,74 @@"api_key": []}],- "summary": "Delete notifications",+ "summary": "Skip optional backup onboarding","tags": [- "Notifications"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "notification.delete",- "x-immich-state": "Stable"- },- "get": {- "description": "Retrieve a list of notifications.",- "operationId": "getNotifications",- "parameters": [+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/onboarding/telemetry": {+ "post": {+ "description": "Record that the user consents to sending telemetry.",+ "operationId": "futoBackupsEnableTelemetry",+ "parameters": [],+ "responses": {+ "201": {+ "description": ""+ }+ },+ "security": [{- "name": "id",- "required": false,- "in": "query",- "description": "Filter by notification ID",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }+ "bearer": []},{- "name": "level",- "required": false,- "in": "query",- "schema": {- "$ref": "#/components/schemas/NotificationLevel"- }+ "cookie": []},{- "name": "type",- "required": false,- "in": "query",- "schema": {- "$ref": "#/components/schemas/NotificationType"- }+ "api_key": []+ }+ ],+ "summary": "Enable FUTO Backups telemetry",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v3.4.0",+ "state": "Added"},{- "name": "unread",- "required": false,- "in": "query",- "description": "Filter by unread status",- "schema": {- "type": "boolean"- }+ "version": "v3.4.0",+ "state": "Internal"}],+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/repository": {+ "get": {+ "description": "List the backup repositories known to this server.",+ "operationId": "futoBackupsGetRepositories",+ "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/NotificationDto"- },- "type": "array"+ "$ref": "#/components/schemas/RepositoryListResponseDto"}}},@@ -8874,43 +8586,55 @@"api_key": []}],- "summary": "Retrieve notifications",+ "summary": "List backups","tags": [- "Notifications"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "notification.read",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"},- "put": {- "description": "Update a list of notifications. Allows to bulk-set the read status of notifications.",- "operationId": "updateNotifications",- "parameters": [],+ "post": {+ "description": "Create a backup repository on a backend.",+ "operationId": "futoBackupsCreateRepository",+ "parameters": [+ {+ "name": "backend",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ }+ ],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/NotificationUpdateAllDto"+ "$ref": "#/components/schemas/RepositoryCreateRequestDto"}}},"required": true},"responses": {- "204": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/RepositoryCreateResponseDto"+ }+ }+ },"description": ""}},@@ -8925,46 +8649,47 @@"api_key": []}],- "summary": "Update notifications",+ "summary": "Create a new backup","tags": [- "Notifications"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "notification.update",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/notifications/{id}": {- "delete": {- "description": "Delete a specific notification.",- "operationId": "deleteNotification",+ "/futo-backups/repository/inspect": {+ "get": {+ "description": "List repositories on a backend that are not configured on this server.",+ "operationId": "futoBackupsInspectRepositories","parameters": [{- "name": "id",- "required": true,- "in": "path",+ "name": "backend",+ "required": false,+ "in": "query","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}],"responses": {- "204": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/RepositoryInspectResponseDto"+ }+ }+ },"description": ""}},@@ -8979,51 +8704,40 @@"api_key": []}],- "summary": "Delete a notification",+ "summary": "List remote backups","tags": [- "Notifications"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "notification.delete",- "x-immich-state": "Stable"- },- "get": {- "description": "Retrieve a specific notification identified by id.",- "operationId": "getNotification",+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/repository/{id}": {+ "delete": {+ "description": "Remove a repository from this server.",+ "operationId": "futoBackupsDeleteRepository","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}],"responses": {"200": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/NotificationDto"- }- }- },"description": ""}},@@ -9038,38 +8752,40 @@"api_key": []}],- "summary": "Get a notification",+ "summary": "Remove a backup","tags": [- "Notifications"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "notification.read",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"},- "put": {- "description": "Update a specific notification to set its read status.",- "operationId": "updateNotification",+ "patch": {+ "description": "Update the settings of a repository.",+ "operationId": "futoBackupsUpdateRepository","parameters": [+ {+ "name": "backend",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}@@ -9078,7 +8794,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/NotificationUpdateDto"+ "$ref": "#/components/schemas/RepositoryUpdateRequestDto"}}},@@ -9089,7 +8805,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/NotificationDto"+ "$ref": "#/components/schemas/RepositoryUpdateResponseDto"}}},@@ -9107,166 +8823,96 @@"api_key": []}],- "summary": "Update a notification",+ "summary": "Update a backup","tags": [- "Notifications"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "notification.update",- "x-immich-state": "Stable"- }- },- "/oauth/authorize": {+ "x-immich-state": "Internal"+ },"post": {- "description": "Initiate the OAuth authorization process.",- "operationId": "startOAuth",- "parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/OAuthConfigDto"- }+ "description": "Queue a backup to a repository and return the ID of its job.",+ "operationId": "futoBackupsCreateBackup",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"}- },- "required": true- },+ }+ ],"responses": {"201": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/OAuthAuthorizeResponseDto"+ "$ref": "#/components/schemas/JobResponseDto"}}},"description": ""}},- "summary": "Start OAuth",- "tags": [- "Authentication"- ],- "x-immich-history": [+ "security": [{- "version": "v1",- "state": "Added"+ "bearer": []},{- "version": "v1",- "state": "Beta"+ "cookie": []},{- "version": "v2",- "state": "Stable"- }- ],- "x-immich-state": "Stable"- }- },- "/oauth/backchannel-logout": {- "post": {- "description": "Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present.",- "operationId": "logoutOAuth",- "parameters": [],- "requestBody": {- "content": {- "application/x-www-form-urlencoded": {- "schema": {- "$ref": "#/components/schemas/OAuthBackchannelLogoutDto"- }- }- },- "required": true- },- "responses": {- "200": {- "description": ""+ "api_key": []}- },- "summary": "Backchannel OAuth logout",- "tags": [- "Authentication"],- "x-immich-history": [- {- "version": "v2",- "state": "Added"- }- ]- }- },- "/oauth/callback": {- "post": {- "description": "Complete the OAuth authorization process by exchanging the authorization code for a session token.",- "operationId": "finishOAuth",- "parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/OAuthCallbackDto"- }- }- },- "required": true- },- "responses": {- "201": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/LoginResponseDto"- }- }- },- "description": ""- }- },- "summary": "Finish OAuth",+ "summary": "Start a backup","tags": [- "Authentication"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/oauth/link": {- "post": {- "description": "Link an OAuth account to the authenticated user.",- "operationId": "linkOAuthAccount",- "parameters": [],+ "/futo-backups/repository/{id}/backend": {+ "put": {+ "description": "Create a new empty repository on the selected backend and redirect future backups to it. Existing snapshots are not migrated.",+ "operationId": "futoBackupsReconfigureRepositoryPrimaryBackend",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ }+ ],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/OAuthCallbackDto"+ "$ref": "#/components/schemas/RepositoryPrimaryBackendReconfigureRequestDto"}}},@@ -9277,7 +8923,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/UserAdminResponseDto"+ "$ref": "#/components/schemas/RepositoryCreateResponseDto"}}},@@ -9295,69 +8941,52 @@"api_key": []}],- "summary": "Link OAuth account",+ "summary": "Change the primary backend","tags": [- "Authentication"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/oauth/mobile-redirect": {+ "/futo-backups/repository/{id}/import": {"get": {- "description": "Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.",- "operationId": "redirectOAuthToMobile",- "parameters": [],- "responses": {- "200": {- "description": ""- }- },- "summary": "Redirect OAuth to mobile",- "tags": [- "Authentication"- ],- "x-immich-history": [- {- "version": "v1",- "state": "Added"- },+ "description": "Check that an existing repository on a backend can be opened with the recovery key.",+ "operationId": "futoBackupsCheckImportRepository",+ "parameters": [{- "version": "v1",- "state": "Beta"+ "name": "backend",+ "required": true,+ "in": "query",+ "schema": {+ "type": "string"+ }},{- "version": "v2",- "state": "Stable"+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }}],- "x-immich-state": "Stable"- }- },- "/oauth/unlink": {- "post": {- "description": "Unlink the OAuth account from the authenticated user.",- "operationId": "unlinkOAuthAccount",- "parameters": [],"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/UserAdminResponseDto"+ "$ref": "#/components/schemas/RepositoryCheckImportResponseDto"}}},@@ -9375,50 +9004,50 @@"api_key": []}],- "summary": "Unlink OAuth account",+ "summary": "Check a repository import","tags": [- "Authentication"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Stable"- }- },- "/partners": {- "get": {- "description": "Retrieve a list of partners with whom assets are shared.",- "operationId": "getPartners",- "parameters": [- {- "name": "direction",+ "x-immich-state": "Internal"+ },+ "post": {+ "description": "Add an existing repository on a backend to this server.",+ "operationId": "futoBackupsImportRepository",+ "parameters": [+ {+ "name": "backend","required": true,"in": "query","schema": {- "$ref": "#/components/schemas/PartnerDirection"+ "type": "string"+ }+ },+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"}}],"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/PartnerResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/RepositoryCreateResponseDto"}}},@@ -9436,47 +9065,44 @@"api_key": []}],- "summary": "Retrieve partners",+ "summary": "Import a repository","tags": [- "Partners"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "partner.read",- "x-immich-state": "Stable"- },- "post": {- "description": "Create a new partner to share assets with.",- "operationId": "createPartner",- "parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PartnerCreateDto"- }+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/repository/{id}/snapshots": {+ "get": {+ "description": "List the snapshots in a repository.",+ "operationId": "futoBackupsGetSnapshots",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"}- },- "required": true- },+ }+ ],"responses": {- "201": {+ "200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PartnerResponseDto"+ "$ref": "#/components/schemas/ListSnapshotsResponseDto"}}},@@ -9494,46 +9120,47 @@"api_key": []}],- "summary": "Create a partner",+ "summary": "List snapshots","tags": [- "Partners"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "partner.create",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/partners/{id}": {- "delete": {- "description": "Stop sharing assets with a partner.",- "operationId": "removePartner",+ "/futo-backups/repository/{id}/snapshots/prune": {+ "post": {+ "description": "Queue the removal of snapshots outside the retention policy and return the ID of its job.",+ "operationId": "futoBackupsPruneRepository","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}],"responses": {- "204": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/JobResponseDto"+ }+ }+ },"description": ""}},@@ -9548,49 +9175,52 @@"api_key": []}],- "summary": "Remove a partner",+ "summary": "Prune a repository","tags": [- "Partners"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "partner.delete",- "x-immich-state": "Stable"- },- "post": {- "deprecated": true,- "description": "Create a new partner to share assets with.",- "operationId": "createPartnerDeprecated",+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/repository/{id}/snapshots/{snapshot}": {+ "delete": {+ "description": "Remove a snapshot from a repository.",+ "operationId": "futoBackupsForgetSnapshot","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "snapshot",+ "required": true,+ "in": "path",+ "schema": {"type": "string"}}],"responses": {- "201": {+ "200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PartnerResponseDto"+ "$ref": "#/components/schemas/ListSnapshotsResponseDto"}}},@@ -9608,36 +9238,40 @@"api_key": []}],- "summary": "Create a partner",+ "summary": "Delete a snapshot","tags": [- "Partners",- "Deprecated"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Deprecated",- "replacementId": "createPartner"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "partner.create",- "x-immich-state": "Deprecated"+ "x-immich-state": "Internal"},- "put": {- "description": "Specify whether a partner's assets should appear in the user's timeline.",- "operationId": "updatePartner",+ "post": {+ "description": "Queue a restore of files from a snapshot and return the ID of its job.",+ "operationId": "futoBackupsRestoreSnapshot","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "snapshot",+ "required": true,+ "in": "path",+ "schema": {"type": "string"}}@@ -9646,18 +9280,18 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PartnerUpdateDto"+ "$ref": "#/components/schemas/RepositorySnapshotRestoreRequestDto"}}},"required": true},"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PartnerResponseDto"+ "$ref": "#/components/schemas/JobResponseDto"}}},@@ -9675,41 +9309,50 @@"api_key": []}],- "summary": "Update a partner",+ "summary": "Restore a snapshot","tags": [- "Partners"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v1",+ "version": "v3.4.0","state": "Added"},{- "version": "v1",- "state": "Beta"- },- {- "version": "v2",- "state": "Stable"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "partner.update",- "x-immich-state": "Stable"+ "x-immich-state": "Internal"}},- "/passkeys": {+ "/futo-backups/repository/{id}/snapshots/{snapshot}/listing": {"get": {- "description": "Search the passkeys of the current user.",- "operationId": "searchPasskeys",+ "description": "List the files and folders at a path in a snapshot.",+ "operationId": "futoBackupsGetSnapshotListing","parameters": [{"name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "path","required": false,"in": "query",- "description": "Filter by passkey ID","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "snapshot",+ "required": true,+ "in": "path",+ "schema": {"type": "string"}}@@ -9719,10 +9362,7 @@"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/PasskeyResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/FilesystemListingResponseDto"}}},@@ -9740,34 +9380,59 @@"api_key": []}],- "summary": "Search passkeys",+ "summary": "List snapshot files","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "passkey.read",- "x-immich-state": "Alpha"+ "x-immich-state": "Internal"}},- "/passkeys/authentication/finish": {+ "/futo-backups/repository/{id}/snapshots/{snapshot}/restore-from-point": {"post": {- "description": "Verify the response from the authenticator and receive a session token.",- "operationId": "finishAuthentication",- "parameters": [],+ "description": "Restore the orchestrator to a previous state, wiping the current state.",+ "operationId": "futoBackupsRestoreFromPoint",+ "parameters": [+ {+ "name": "backend",+ "required": true,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "snapshot",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ }+ ],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyAuthenticationFinishDto"+ "$ref": "#/components/schemas/RepositorySnapshotRestoreFromPointRequestDto"}}},@@ -9778,85 +9443,108 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/LoginResponseDto"+ "$ref": "#/components/schemas/JobResponseDto"}}},"description": ""}},- "summary": "Finish passkey authentication",+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Restore from snapshot","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Alpha"+ "x-immich-state": "Internal"}},- "/passkeys/authentication/start": {+ "/futo-backups/repository/{id}/sync-deletion": {"post": {- "description": "Generate the options used by the browser to sign in with a passkey.",- "operationId": "startAuthentication",- "parameters": [],+ "description": "Remove a repository from this server once it has been deleted from its backend.",+ "operationId": "futoBackupsSyncRepositoryDeletion",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ }+ ],"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyAuthenticationOptionsDto"+ "$ref": "#/components/schemas/RepositorySyncDeletionResponseDto"}}},"description": ""}},- "summary": "Start passkey authentication",+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Sync a remote deletion","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Alpha"+ "x-immich-state": "Internal"}},- "/passkeys/registration/finish": {- "post": {- "description": "Verify the response from the authenticator and save the new passkey for the current user.",- "operationId": "finishRegistration",+ "/futo-backups/schedule": {+ "get": {+ "description": "List the backup schedules.",+ "operationId": "futoBackupsGetSchedules","parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PasskeyRegistrationFinishDto"- }- }- },- "required": true- },"responses": {- "201": {+ "200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyResponseDto"+ "$ref": "#/components/schemas/ScheduleListResponseDto"}}},@@ -9874,34 +9562,43 @@"api_key": []}],- "summary": "Finish passkey registration",+ "summary": "List schedules","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Alpha"- }- },- "/passkeys/registration/start": {+ "x-immich-state": "Internal"+ },"post": {- "description": "Generate the options used by the browser to create a new passkey for the current user.",- "operationId": "startRegistration",+ "description": "Create a backup schedule for one or more repositories.",+ "operationId": "futoBackupsCreateSchedule","parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ScheduleCreateRequestDto"+ }+ }+ },+ "required": true+ },"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyRegistrationOptionsDto"+ "$ref": "#/components/schemas/ScheduleCreateResponseDto"}}},@@ -9919,41 +9616,40 @@"api_key": []}],- "summary": "Start passkey registration",+ "summary": "Create a schedule","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-state": "Alpha"+ "x-immich-state": "Internal"}},- "/passkeys/{id}": {+ "/futo-backups/schedule/{id}": {"delete": {- "description": "Delete a passkey by its ID. The current user must own this passkey.",- "operationId": "deletePasskey",+ "description": "Delete a backup schedule.",+ "operationId": "futoBackupsRemoveSchedule","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}],"responses": {- "204": {+ "200": {"description": ""}},@@ -9968,44 +9664,52 @@"api_key": []}],- "summary": "Delete a passkey",+ "summary": "Delete a schedule","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "passkey.delete",- "x-immich-state": "Alpha"+ "x-immich-state": "Internal"},- "get": {- "description": "Retrieve a passkey by its ID. The current user must own this passkey.",- "operationId": "getPasskey",+ "patch": {+ "description": "Update a backup schedule.",+ "operationId": "futoBackupsUpdateSchedule","parameters": [{"name": "id","required": true,"in": "path","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ScheduleUpdateRequestDto"+ }+ }+ },+ "required": true+ },"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyResponseDto"+ "$ref": "#/components/schemas/ScheduleUpdateResponseDto"}}},@@ -10023,43 +9727,78 @@"api_key": []}],- "summary": "Retrieve a passkey",+ "summary": "Update a schedule","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "passkey.read",- "x-immich-state": "Alpha"- },- "patch": {- "description": "Update the name of a passkey by its ID. The current user must own this passkey.",- "operationId": "updatePasskey",- "parameters": [+ "x-immich-state": "Internal"+ }+ },+ "/futo-backups/support-mode": {+ "get": {+ "description": "Retrieve how many upcoming runs use verbose restic logging, and whether they stream to FUTO.",+ "operationId": "futoBackupsGetSupportMode",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/SupportModeResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [{- "name": "id",- "required": true,- "in": "path",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Get support mode",+ "tags": [+ "Backups"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v3.4.0",+ "state": "Added"+ },+ {+ "version": "v3.4.0",+ "state": "Internal"}],+ "x-immich-state": "Internal"+ },+ "put": {+ "description": "Set how many upcoming runs use verbose restic logging, and whether they stream to FUTO.",+ "operationId": "futoBackupsUpdateSupportMode",+ "parameters": [],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyUpdateDto"+ "$ref": "#/components/schemas/SupportModeUpdateRequestDto"}}},@@ -10070,7 +9809,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PasskeyResponseDto"+ "$ref": "#/components/schemas/SupportModeResponseDto"}}},@@ -10088,41 +9827,39 @@"api_key": []}],- "summary": "Update a passkey",+ "summary": "Update support mode","tags": [- "Passkeys"+ "Backups"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v4.0.0",+ "version": "v3.4.0","state": "Added"},{- "version": "v4.0.0",- "state": "Alpha"+ "version": "v3.4.0",+ "state": "Internal"}],- "x-immich-permission": "passkey.update",- "x-immich-state": "Alpha"+ "x-immich-state": "Internal"}},- "/people": {- "delete": {- "description": "Bulk delete a list of people at once.",- "operationId": "deletePeople",+ "/jobs": {+ "get": {+ "deprecated": true,+ "description": "Retrieve the counts of the current queue, as well as the current status.",+ "operationId": "getQueuesLegacy","parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PeopleDeleteDto"- }- }- },- "required": true- },"responses": {- "204": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/QueuesResponseLegacyDto"+ }+ }+ },"description": ""}},@@ -10137,10 +9874,12 @@"api_key": []}],- "summary": "Delete people",+ "summary": "Retrieve queue counts and status","tags": [- "People"+ "Jobs",+ "Deprecated"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10153,129 +9892,31 @@{"version": "v2","state": "Stable"+ },+ {+ "version": "v2.4.0",+ "state": "Deprecated"}],- "x-immich-permission": "person.delete",- "x-immich-state": "Stable"+ "x-immich-permission": "job.read",+ "x-immich-state": "Deprecated"},- "get": {- "description": "Retrieve a list of all people.",- "operationId": "getAllPeople",- "parameters": [- {- "name": "closestAssetId",- "required": false,- "in": "query",- "description": "Closest asset ID for similarity search",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }- },- {- "name": "closestPersonId",- "required": false,- "in": "query",- "description": "Closest person ID for similarity search",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"- }- },- {- "name": "isFavorite",- "required": false,- "in": "query",- "description": "Filter by favorite status",- "schema": {- "type": "boolean"- }- },- {- "name": "isHidden",- "required": false,- "in": "query",- "description": "Filter by hidden status",- "schema": {- "type": "boolean"- }- },- {- "name": "name",- "required": false,- "in": "query",- "description": "Filter by person name",- "schema": {- "type": "string"- }- },- {- "name": "page",- "required": false,- "in": "query",- "description": "Page number for pagination",- "schema": {- "minimum": 1,- "maximum": 9007199254740991,- "default": 1,- "type": "integer"- }- },- {- "name": "sharedById",- "required": false,- "in": "query",- "description": "Only include people to which the user gave access",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",- "type": "string"- }- },- {- "name": "sharedWithId",- "required": false,- "in": "query",- "description": "Only include people to which the user was given access",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",- "type": "string"- }- },- {- "name": "size",- "required": false,- "in": "query",- "description": "Number of items per page",- "schema": {- "minimum": 1,- "maximum": 1000,- "default": 500,- "type": "integer"+ "post": {+ "description": "Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.",+ "operationId": "createJob",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/JobCreateDto"+ }}},- {- "name": "withHidden",- "required": false,- "in": "query",- "description": "Include hidden people",- "schema": {- "type": "boolean"- }- }- ],+ "required": true+ },"responses": {- "200": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PeopleResponseDto"- }- }- },+ "204": {"description": ""}},@@ -10290,10 +9931,11 @@"api_key": []}],- "summary": "Get all people",+ "summary": "Create a manual job","tags": [- "People"+ "Jobs"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10308,29 +9950,41 @@"state": "Stable"}],- "x-immich-permission": "person.read",+ "x-immich-permission": "job.create","x-immich-state": "Stable"- },- "post": {- "description": "Create a new person that can have multiple faces assigned to them.",- "operationId": "createPerson",- "parameters": [],+ }+ },+ "/jobs/{name}": {+ "put": {+ "deprecated": true,+ "description": "Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.",+ "operationId": "runQueueCommandLegacy",+ "parameters": [+ {+ "name": "name",+ "required": true,+ "in": "path",+ "schema": {+ "$ref": "#/components/schemas/QueueName"+ }+ }+ ],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PersonCreateDto"+ "$ref": "#/components/schemas/QueueCommandDto"}}},"required": true},"responses": {- "201": {+ "200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PersonResponseDto"+ "$ref": "#/components/schemas/QueueResponseLegacyDto"}}},@@ -10348,10 +10002,12 @@"api_key": []}],- "summary": "Create a person",+ "summary": "Run jobs","tags": [- "People"+ "Jobs",+ "Deprecated"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10364,32 +10020,28 @@{"version": "v2","state": "Stable"+ },+ {+ "version": "v2.4.0",+ "state": "Deprecated"}],- "x-immich-permission": "person.create",- "x-immich-state": "Stable"- },- "put": {- "description": "Bulk update multiple people at once.",- "operationId": "updatePeople",+ "x-immich-permission": "job.create",+ "x-immich-state": "Deprecated"+ }+ },+ "/libraries": {+ "get": {+ "description": "Retrieve a list of external libraries.",+ "operationId": "getAllLibraries","parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PeopleUpdateDto"- }- }- },- "required": true- },"responses": {"200": {"content": {"application/json": {"schema": {"items": {- "$ref": "#/components/schemas/BulkIdResponseDto"+ "$ref": "#/components/schemas/LibraryResponseDto"},"type": "array"}@@ -10409,10 +10061,11 @@"api_key": []}],- "summary": "Update people",+ "summary": "Retrieve libraries","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10427,34 +10080,29 @@"state": "Stable"}],- "x-immich-permission": "person.update",+ "x-immich-permission": "library.read","x-immich-state": "Stable"- }- },- "/people/merge": {+ },"post": {- "description": "Merge an ordered list of people together into a single person. The final name and birth date are always the first defined value, following the order. Also automatically merges people for other users in the cluster group, skipping people that would result in overriding a previously set name or birth date.",- "operationId": "mergePeople",+ "description": "Create a new external library.",+ "operationId": "createLibrary","parameters": [],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/MergePersonDto"+ "$ref": "#/components/schemas/CreateLibraryDto"}}},"required": true},"responses": {- "200": {+ "201": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/BulkIdResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/LibraryResponseDto"}}},@@ -10472,41 +10120,47 @@"api_key": []}],- "summary": "Merge people",+ "summary": "Create a library","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v3.2.1",+ "version": "v1","state": "Added"},{- "version": "v3.2.1",+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2","state": "Stable"}],- "x-immich-permission": "person.merge",+ "x-immich-permission": "library.create","x-immich-state": "Stable"}},- "/people/users": {+ "/libraries/{id}": {"delete": {- "description": "Remove user access to people",- "operationId": "removeUsersFromPeople",- "parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PersonUsersDeleteDto"- }+ "description": "Delete an external library by its ID.",+ "operationId": "deleteLibrary",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"}- },- "required": true- },+ }+ ],"responses": {- "200": {+ "204": {"description": ""}},@@ -10521,74 +10175,39 @@"api_key": []}],- "summary": "Remove users from people",+ "summary": "Delete a library","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v3.3.0",+ "version": "v1","state": "Added"},{- "version": "v3.3.0",+ "version": "v1","state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "person.update",- "x-immich-state": "Beta"+ "x-immich-permission": "library.delete",+ "x-immich-state": "Stable"},"get": {- "description": "Retrieve a list of users and the people to which they have been given access",- "operationId": "getUsersForPeople",+ "description": "Retrieve an external library by its ID.",+ "operationId": "getLibrary","parameters": [{- "name": "direction",- "required": false,- "in": "query",- "schema": {- "$ref": "#/components/schemas/SharingDirection"- }- },- {- "name": "personId",- "required": false,- "in": "query",- "description": "Person ID",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",- "type": "string"- }- },- {- "name": "role",- "required": false,- "in": "query",- "description": "Role of user",- "schema": {- "$ref": "#/components/schemas/PersonUserRole"- }- },- {- "name": "sharedById",- "required": false,- "in": "query",- "description": "User ID of the user that gave access",- "schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",- "type": "string"- }- },- {- "name": "sharedWithId",- "required": false,- "in": "query",- "description": "User ID of the user that was given access",+ "name": "id",+ "required": true,+ "in": "path","schema": {"format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}}@@ -10598,7 +10217,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PersonUsersResponseDto"+ "$ref": "#/components/schemas/LibraryResponseDto"}}},@@ -10616,75 +10235,31 @@"api_key": []}],- "summary": "Get people access",+ "summary": "Retrieve a library","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{- "version": "v3.3.0",+ "version": "v1","state": "Added"},{- "version": "v3.3.0",+ "version": "v1","state": "Beta"- }- ],- "x-immich-permission": "person.read",- "x-immich-state": "Beta"- },- "put": {- "description": "Give users access to people",- "operationId": "upsertPeopleUsers",- "parameters": [],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PeopleUsersUpsertDto"- }- }- },- "required": true- },- "responses": {- "200": {- "description": ""- }- },- "security": [- {- "bearer": []- },- {- "cookie": []- },- {- "api_key": []- }- ],- "summary": "Upsert user access",- "tags": [- "People"- ],- "x-immich-history": [- {- "version": "v3.3.0",- "state": "Added"},{- "version": "v3.3.0",- "state": "Beta"+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "person.update",- "x-immich-state": "Beta"- }- },- "/people/{id}": {- "delete": {- "description": "Delete an individual person.",- "operationId": "deletePerson",+ "x-immich-permission": "library.read",+ "x-immich-state": "Stable"+ },+ "put": {+ "description": "Update an existing external library.",+ "operationId": "updateLibrary","parameters": [{"name": "id",@@ -10701,14 +10276,21 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PersonDeleteDto"+ "$ref": "#/components/schemas/UpdateLibraryDto"}}},"required": true},"responses": {- "204": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/LibraryResponseDto"+ }+ }+ },"description": ""}},@@ -10723,10 +10305,11 @@"api_key": []}],- "summary": "Delete person",+ "summary": "Update a library","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10739,14 +10322,21 @@{"version": "v2","state": "Stable"+ },+ {+ "version": "v3.0.0",+ "state": "Updated",+ "description": "This endpoint now also supports PATCH, in addition to PUT. PATCH will become the default in v4, and then PUT will be dropped in v5. Please migrate accordingly."}],- "x-immich-permission": "person.delete",+ "x-immich-permission": "library.update","x-immich-state": "Stable"- },- "get": {- "description": "Retrieve a person by id.",- "operationId": "getPerson",+ }+ },+ "/libraries/{id}/scan": {+ "post": {+ "description": "Queue a scan for the external library to find and import new assets.",+ "operationId": "scanLibrary","parameters": [{"name": "id",@@ -10760,14 +10350,7 @@}],"responses": {- "200": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PersonResponseDto"- }- }- },+ "204": {"description": ""}},@@ -10782,10 +10365,11 @@"api_key": []}],- "summary": "Get a person",+ "summary": "Scan a library","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10800,12 +10384,14 @@"state": "Stable"}],- "x-immich-permission": "person.read",+ "x-immich-permission": "library.update","x-immich-state": "Stable"- },- "put": {- "description": "Update an individual person.",- "operationId": "updatePerson",+ }+ },+ "/libraries/{id}/statistics": {+ "get": {+ "description": "Retrieve statistics for a specific external library, including number of videos, images, and storage usage.",+ "operationId": "getLibraryStatistics","parameters": [{"name": "id",@@ -10818,22 +10404,12 @@}}],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PersonUpdateDto"- }- }- },- "required": true- },"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PersonResponseDto"+ "$ref": "#/components/schemas/LibraryStatsResponseDto"}}},@@ -10851,10 +10427,11 @@"api_key": []}],- "summary": "Update person",+ "summary": "Retrieve library statistics","tags": [- "People"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10867,22 +10444,16 @@{"version": "v2","state": "Stable"- },- {- "version": "v3.0.0",- "state": "Updated",- "description": "This endpoint now also supports PATCH, in addition to PUT. PATCH will become the default in v4, and then PUT will be dropped in v5. Please migrate accordingly."}],- "x-immich-permission": "person.update",+ "x-immich-permission": "library.statistics","x-immich-state": "Stable"}},- "/people/{id}/merge": {+ "/libraries/{id}/validate": {"post": {- "deprecated": true,- "description": "Merge a list of people into the person specified in the path parameter.",- "operationId": "mergePersonLegacy",+ "description": "Validate the settings of an external library.",+ "operationId": "validate","parameters": [{"name": "id",@@ -10899,7 +10470,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/MergePersonDto"+ "$ref": "#/components/schemas/ValidateLibraryDto"}}},@@ -10910,10 +10481,7 @@"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/BulkIdResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/ValidateLibraryResponseDto"}}},@@ -10931,11 +10499,11 @@"api_key": []}],- "summary": "Merge people",+ "summary": "Validate library settings","tags": [- "People",- "Deprecated"+ "Libraries"],+ "x-immich-admin-only": true,"x-immich-history": [{"version": "v1",@@ -10948,50 +10516,84 @@{"version": "v2","state": "Stable"- },- {- "version": "v3.2.1",- "state": "Deprecated",- "replacementId": "mergePeople"}],- "x-immich-permission": "person.merge",- "x-immich-state": "Deprecated"+ "x-immich-state": "Stable"}},- "/people/{id}/reassign": {- "put": {- "description": "Bulk reassign a list of faces to a different person.",- "operationId": "reassignFaces",+ "/map/markers": {+ "get": {+ "description": "Retrieve a list of latitude and longitude coordinates for every asset with location data.",+ "operationId": "getMapMarkers","parameters": [{- "name": "id",- "required": true,- "in": "path",+ "name": "fileCreatedAfter",+ "required": false,+ "in": "query",+ "description": "Filter assets created after this date","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "format": "date-time",+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",+ "example": "2024-01-01T00:00:00.000Z","type": "string"}- }- ],- "requestBody": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/AssetFaceUpdateDto"- }+ },+ {+ "name": "fileCreatedBefore",+ "required": false,+ "in": "query",+ "description": "Filter assets created before this date",+ "schema": {+ "format": "date-time",+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",+ "example": "2024-01-01T00:00:00.000Z",+ "type": "string"}},- "required": true- },+ {+ "name": "isArchived",+ "required": false,+ "in": "query",+ "description": "Filter by archived status",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "isFavorite",+ "required": false,+ "in": "query",+ "description": "Filter by favorite status",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "withPartners",+ "required": false,+ "in": "query",+ "description": "Include partner assets",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "withSharedAlbums",+ "required": false,+ "in": "query",+ "description": "Include shared album assets",+ "schema": {+ "type": "boolean"+ }+ }+ ],"responses": {"200": {"content": {"application/json": {"schema": {"items": {- "$ref": "#/components/schemas/PersonResponseDto"+ "$ref": "#/components/schemas/MapMarkerResponseDto"},"type": "array"}@@ -11011,9 +10613,9 @@"api_key": []}],- "summary": "Reassign faces",+ "summary": "Retrieve map markers","tags": [- "People"+ "Map"],"x-immich-history": [{@@ -11029,23 +10631,33 @@"state": "Stable"}],- "x-immich-permission": "person.reassign",+ "x-immich-permission": "map.read","x-immich-state": "Stable"}},- "/people/{id}/statistics": {+ "/map/reverse-geocode": {"get": {- "description": "Retrieve statistics about a specific person.",- "operationId": "getPersonStatistics",+ "description": "Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.",+ "operationId": "reverseGeocode","parameters": [{- "name": "id",+ "name": "lat","required": true,- "in": "path",+ "in": "query",+ "description": "Latitude (-90 to 90)","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"+ "format": "double",+ "type": "number"+ }+ },+ {+ "name": "lon",+ "required": true,+ "in": "query",+ "description": "Longitude (-180 to 180)",+ "schema": {+ "format": "double",+ "type": "number"}}],@@ -11054,7 +10666,10 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PersonStatisticsResponseDto"+ "items": {+ "$ref": "#/components/schemas/MapReverseGeocodeResponseDto"+ },+ "type": "array"}}},@@ -11072,9 +10687,9 @@"api_key": []}],- "summary": "Get person statistics",+ "summary": "Reverse geocode coordinates","tags": [- "People"+ "Map"],"x-immich-history": [{@@ -11090,127 +10705,101 @@"state": "Stable"}],- "x-immich-permission": "person.statistics",+ "x-immich-permission": "map.search","x-immich-state": "Stable"}},- "/people/{id}/thumbnail": {+ "/memories": {"get": {- "description": "Retrieve the thumbnail file for a person.",- "operationId": "getPersonThumbnail",+ "description": "Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly.",+ "operationId": "searchMemories","parameters": [+ {+ "name": "for",+ "required": false,+ "in": "query",+ "description": "Filter by date",+ "schema": {+ "format": "date",+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",+ "example": "2024-01-01",+ "type": "string"+ }+ },{"name": "id",- "required": true,- "in": "path",+ "required": false,+ "in": "query",+ "description": "Memory ID","schema": {"format": "uuid","pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"}- }- ],- "responses": {- "200": {- "content": {- "application/octet-stream": {- "schema": {- "format": "binary",- "type": "string"- }- }- },- "description": ""- }- },- "security": [- {- "bearer": []- },- {- "cookie": []- },- {- "api_key": []- }- ],- "summary": "Get person thumbnail",- "tags": [- "People"- ],- "x-immich-history": [- {- "version": "v1",- "state": "Added"},{- "version": "v1",- "state": "Beta"+ "name": "isSaved",+ "required": false,+ "in": "query",+ "description": "Filter by saved status",+ "schema": {+ "type": "boolean"+ }},{- "version": "v2",- "state": "Stable"- }- ],- "x-immich-permission": "person.read",- "x-immich-state": "Stable"- }- },- "/plugins": {- "get": {- "description": "Retrieve a list of plugins available to the authenticated user.",- "operationId": "searchPlugins",- "parameters": [- {- "name": "description",+ "name": "isTrashed","required": false,"in": "query",+ "description": "Include trashed memories","schema": {- "type": "string"+ "type": "boolean"}},{- "name": "enabled",+ "name": "isUpcoming","required": false,"in": "query",- "description": "Whether the plugin is enabled",+ "description": "Filter by memories that have not been shown yet","schema": {"type": "boolean"}},{- "name": "id",+ "name": "order","required": false,"in": "query",- "description": "Plugin ID","schema": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"+ "$ref": "#/components/schemas/MemorySearchOrder"}},{- "name": "name",+ "name": "page","required": false,"in": "query",+ "description": "Page number","schema": {- "type": "string"+ "minimum": 1,+ "maximum": 9007199254740991,+ "type": "integer"}},{- "name": "title",+ "name": "size","required": false,"in": "query",+ "description": "Number of memories to return","schema": {- "type": "string"+ "minimum": 1,+ "maximum": 9007199254740991,+ "type": "integer"}},{- "name": "version",+ "name": "type","required": false,"in": "query","schema": {- "type": "string"+ "$ref": "#/components/schemas/MemoryType"}}],@@ -11220,7 +10809,7 @@"application/json": {"schema": {"items": {- "$ref": "#/components/schemas/PluginResponseDto"+ "$ref": "#/components/schemas/MemoryResponseDto"},"type": "array"}@@ -11240,46 +10829,108 @@"api_key": []}],- "summary": "List all plugins",+ "summary": "Retrieve memories","tags": [- "Plugins"+ "Memories"],"x-immich-history": [{- "version": "v3.0.0",+ "version": "v1","state": "Added"- }- ],- "x-immich-permission": "plugin.read"- }- },- "/plugins/methods": {- "get": {- "description": "Retrieve a list of plugin methods",- "operationId": "searchPluginMethods",- "parameters": [+ },{- "name": "description",- "required": false,- "in": "query",- "schema": {- "type": "string"- }+ "version": "v1",+ "state": "Beta"},{- "name": "enabled",- "required": false,+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "memory.read",+ "x-immich-state": "Stable"+ },+ "post": {+ "description": "Create a new memory by providing a name, description, and a list of asset IDs to include in the memory.",+ "operationId": "createMemory",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/MemoryCreateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/MemoryResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Create a memory",+ "tags": [+ "Memories"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "memory.create",+ "x-immich-state": "Stable"+ }+ },+ "/memories/statistics": {+ "get": {+ "description": "Retrieve statistics about memories, such as total count and other relevant metrics.",+ "operationId": "memoriesStatistics",+ "parameters": [+ {+ "name": "for",+ "required": false,"in": "query",- "description": "Whether the plugin method is enabled",+ "description": "Filter by date","schema": {- "type": "boolean"+ "format": "date",+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",+ "example": "2024-01-01",+ "type": "string"}},{"name": "id","required": false,"in": "query",- "description": "Plugin method ID",+ "description": "Memory ID","schema": {"format": "uuid","pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",@@ -11287,55 +10938,68 @@}},{- "name": "name",+ "name": "isSaved","required": false,"in": "query",+ "description": "Filter by saved status","schema": {- "type": "string"+ "type": "boolean"}},{- "name": "pluginName",+ "name": "isTrashed","required": false,"in": "query",- "description": "Plugin name",+ "description": "Include trashed memories","schema": {- "type": "string"+ "type": "boolean"}},{- "name": "pluginVersion",+ "name": "isUpcoming","required": false,"in": "query",- "description": "Plugin version",+ "description": "Filter by memories that have not been shown yet","schema": {- "type": "string"+ "type": "boolean"}},{- "name": "title",+ "name": "order","required": false,"in": "query","schema": {- "type": "string"+ "$ref": "#/components/schemas/MemorySearchOrder"}},{- "name": "trigger",+ "name": "page","required": false,"in": "query",- "description": "Workflow trigger",+ "description": "Page number","schema": {- "$ref": "#/components/schemas/WorkflowTrigger"+ "minimum": 1,+ "maximum": 9007199254740991,+ "type": "integer"+ }+ },+ {+ "name": "size",+ "required": false,+ "in": "query",+ "description": "Number of memories to return",+ "schema": {+ "minimum": 1,+ "maximum": 9007199254740991,+ "type": "integer"}},{"name": "type","required": false,"in": "query",- "description": "Workflow types","schema": {- "$ref": "#/components/schemas/WorkflowType"+ "$ref": "#/components/schemas/MemoryType"}}],@@ -11344,10 +11008,7 @@"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/PluginMethodResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/MemoryStatisticsResponseDto"}}},@@ -11365,36 +11026,46 @@"api_key": []}],- "summary": "Retrieve plugin methods",+ "summary": "Retrieve memories statistics","tags": [- "Plugins"+ "Memories"],"x-immich-history": [{- "version": "v3.0.0",+ "version": "v1","state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "plugin.read"+ "x-immich-permission": "memory.statistics",+ "x-immich-state": "Stable"}},- "/plugins/templates": {- "get": {- "description": "Retrieve workflow templates provided by installed plugins",- "operationId": "searchPluginTemplates",- "parameters": [],+ "/memories/{id}": {+ "delete": {+ "description": "Delete a specific memory by its ID.",+ "operationId": "deleteMemory",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],"responses": {- "200": {- "content": {- "application/json": {- "schema": {- "items": {- "$ref": "#/components/schemas/PluginTemplateResponseDto"- },- "type": "array"- }- }- },+ "204": {"description": ""}},@@ -11409,23 +11080,30 @@"api_key": []}],- "summary": "Retrieve workflow templates",+ "summary": "Delete a memory","tags": [- "Plugins"+ "Memories"],"x-immich-history": [{- "version": "v3.0.0",+ "version": "v1","state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "plugin.read"- }- },- "/plugins/{id}": {+ "x-immich-permission": "memory.delete",+ "x-immich-state": "Stable"+ },"get": {- "description": "Retrieve information about a specific plugin by its ID.",- "operationId": "getPlugin",+ "description": "Retrieve a specific memory by its ID.",+ "operationId": "getMemory","parameters": [{"name": "id",@@ -11443,7 +11121,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/PluginResponseDto"+ "$ref": "#/components/schemas/MemoryResponseDto"}}},@@ -11461,101 +11139,58 @@"api_key": []}],- "summary": "Retrieve a plugin",+ "summary": "Retrieve a memory","tags": [- "Plugins"+ "Memories"],"x-immich-history": [{- "version": "v3.0.0",+ "version": "v1","state": "Added"- }- ],- "x-immich-permission": "plugin.read"- }- },- "/public/config": {- "get": {- "description": "Retrieve the system configuration properties that are visible to everyone.",- "operationId": "getPublicConfig",- "parameters": [],- "responses": {- "200": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PublicConfigDto"- }- }- },- "description": ""- }- },- "summary": "Get the public configuration",- "tags": [- "Config (public)"- ],- "x-immich-history": [+ },{- "version": "v3.2.0",- "state": "Added"+ "version": "v1",+ "state": "Beta"},{- "version": "v3.2.0",- "state": "Alpha"+ "version": "v2",+ "state": "Stable"}],- "x-immich-state": "Alpha"- }- },- "/public/config/defaults": {- "get": {- "description": "Retrieve the default value of the configuration properties that are visible to everyone.",- "operationId": "getPublicConfigDefaults",- "parameters": [],- "responses": {- "200": {- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/PublicConfigDto"- }- }- },- "description": ""- }- },- "summary": "Get the public configuration defaults",- "tags": [- "Config (public)"- ],- "x-immich-history": [- {- "version": "v3.2.0",- "state": "Added"- },+ "x-immich-permission": "memory.read",+ "x-immich-state": "Stable"+ },+ "put": {+ "description": "Update an existing memory by its ID.",+ "operationId": "updateMemory",+ "parameters": [{- "version": "v3.2.0",- "state": "Alpha"+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }}],- "x-immich-state": "Alpha"- }- },- "/queues": {- "get": {- "description": "Retrieves a list of queues.",- "operationId": "getQueues",- "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/MemoryUpdateDto"+ }+ }+ },+ "required": true+ },"responses": {"200": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/QueueResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/MemoryResponseDto"}}},@@ -11573,45 +11208,68 @@"api_key": []}],- "summary": "List all queues",+ "summary": "Update a memory","tags": [- "Queues"+ "Memories"],- "x-immich-admin-only": true,"x-immich-history": [{- "version": "v2.4.0",+ "version": "v1","state": "Added"},{- "version": "v2.4.0",- "state": "Alpha"+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.0.0",+ "state": "Updated",+ "description": "This endpoint now also supports PATCH, in addition to PUT. PATCH will become the default in v4, and then PUT will be dropped in v5. Please migrate accordingly."}],- "x-immich-permission": "queue.read",- "x-immich-state": "Alpha"+ "x-immich-permission": "memory.update",+ "x-immich-state": "Stable"}},- "/queues/{name}": {- "get": {- "description": "Retrieves a specific queue by its name.",- "operationId": "getQueue",+ "/memories/{id}/assets": {+ "delete": {+ "description": "Remove a list of asset IDs from a specific memory.",+ "operationId": "removeMemoryAssets","parameters": [{- "name": "name",+ "name": "id","required": true,"in": "path","schema": {- "$ref": "#/components/schemas/QueueName"+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"}}],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/BulkIdsDto"+ }+ }+ },+ "required": true+ },"responses": {"200": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/QueueResponseDto"+ "items": {+ "$ref": "#/components/schemas/BulkIdResponseDto"+ },+ "type": "array"}}},@@ -11629,34 +11287,39 @@"api_key": []}],- "summary": "Retrieve a queue",+ "summary": "Remove assets from a memory","tags": [- "Queues"+ "Memories"],- "x-immich-admin-only": true,"x-immich-history": [{- "version": "v2.4.0",+ "version": "v1","state": "Added"},{- "version": "v2.4.0",- "state": "Alpha"+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "queue.read",- "x-immich-state": "Alpha"+ "x-immich-permission": "memoryAsset.delete",+ "x-immich-state": "Stable"},"put": {- "description": "Change the paused status of a specific queue.",- "operationId": "updateQueue",+ "description": "Add a list of asset IDs to a specific memory.",+ "operationId": "addMemoryAssets","parameters": [{- "name": "name",+ "name": "id","required": true,"in": "path","schema": {- "$ref": "#/components/schemas/QueueName"+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"}}],@@ -11664,7 +11327,7 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/QueueUpdateDto"+ "$ref": "#/components/schemas/BulkIdsDto"}}},@@ -11675,7 +11338,10 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/QueueResponseDto"+ "items": {+ "$ref": "#/components/schemas/BulkIdResponseDto"+ },+ "type": "array"}}},@@ -11693,44 +11359,38 @@"api_key": []}],- "summary": "Update a queue",+ "summary": "Add assets to a memory","tags": [- "Queues"+ "Memories"],- "x-immich-admin-only": true,"x-immich-history": [{- "version": "v2.4.0",+ "version": "v1","state": "Added"},{- "version": "v2.4.0",- "state": "Alpha"+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "queue.update",- "x-immich-state": "Alpha"+ "x-immich-permission": "memoryAsset.create",+ "x-immich-state": "Stable"}},- "/queues/{name}/jobs": {+ "/notifications": {"delete": {- "description": "Removes all jobs from the specified queue.",- "operationId": "emptyQueue",- "parameters": [- {- "name": "name",- "required": true,- "in": "path",- "schema": {- "$ref": "#/components/schemas/QueueName"- }- }- ],+ "description": "Delete a list of notifications at once.",+ "operationId": "deleteNotifications",+ "parameters": [],"requestBody": {"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/QueueDeleteDto"+ "$ref": "#/components/schemas/NotificationDeleteAllDto"}}},@@ -11752,46 +11412,65 @@"api_key": []}],- "summary": "Empty a queue",+ "summary": "Delete notifications","tags": [- "Queues"+ "Notifications"],- "x-immich-admin-only": true,"x-immich-history": [{- "version": "v2.4.0",+ "version": "v1","state": "Added"},{- "version": "v2.4.0",- "state": "Alpha"+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "queueJob.delete",- "x-immich-state": "Alpha"+ "x-immich-permission": "notification.delete",+ "x-immich-state": "Stable"},"get": {- "description": "Retrieves a list of queue jobs from the specified queue.",- "operationId": "getQueueJobs",+ "description": "Retrieve a list of notifications.",+ "operationId": "getNotifications","parameters": [{- "name": "name",- "required": true,- "in": "path",+ "name": "id",+ "required": false,+ "in": "query",+ "description": "Filter by notification ID","schema": {- "$ref": "#/components/schemas/QueueName"+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"}},{- "name": "status",+ "name": "level","required": false,"in": "query",- "description": "Filter jobs by status","schema": {- "type": "array",- "items": {- "$ref": "#/components/schemas/QueueJobStatus"- }+ "$ref": "#/components/schemas/NotificationLevel"+ }+ },+ {+ "name": "type",+ "required": false,+ "in": "query",+ "schema": {+ "$ref": "#/components/schemas/NotificationType"+ }+ },+ {+ "name": "unread",+ "required": false,+ "in": "query",+ "description": "Filter by unread status",+ "schema": {+ "type": "boolean"}}],@@ -11801,7 +11480,7 @@"application/json": {"schema": {"items": {- "$ref": "#/components/schemas/QueueJobResponseDto"+ "$ref": "#/components/schemas/NotificationDto"},"type": "array"}@@ -11821,39 +11500,153 @@"api_key": []}],- "summary": "Retrieve queue jobs",+ "summary": "Retrieve notifications","tags": [- "Queues"+ "Notifications"],- "x-immich-admin-only": true,"x-immich-history": [{- "version": "v2.4.0",+ "version": "v1","state": "Added"},{- "version": "v2.4.0",- "state": "Alpha"+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"}],- "x-immich-permission": "queueJob.read",- "x-immich-state": "Alpha"+ "x-immich-permission": "notification.read",+ "x-immich-state": "Stable"+ },+ "put": {+ "description": "Update a list of notifications. Allows to bulk-set the read status of notifications.",+ "operationId": "updateNotifications",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/NotificationUpdateAllDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Update notifications",+ "tags": [+ "Notifications"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "notification.update",+ "x-immich-state": "Stable"}},- "/search/cities": {+ "/notifications/{id}": {+ "delete": {+ "description": "Delete a specific notification.",+ "operationId": "deleteNotification",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Delete a notification",+ "tags": [+ "Notifications"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "notification.delete",+ "x-immich-state": "Stable"+ },"get": {- "description": "Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.",- "operationId": "getAssetsByCity",- "parameters": [],+ "description": "Retrieve a specific notification identified by id.",+ "operationId": "getNotification",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],"responses": {"200": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/AssetResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/NotificationDto"}}},@@ -11871,9 +11664,9 @@"api_key": []}],- "summary": "Retrieve assets by city",+ "summary": "Get a notification","tags": [- "Search"+ "Notifications"],"x-immich-history": [{@@ -11889,24 +11682,40 @@"state": "Stable"}],- "x-immich-permission": "asset.read",+ "x-immich-permission": "notification.read","x-immich-state": "Stable"- }- },- "/search/explore": {- "get": {- "description": "Retrieve data for the explore section, such as popular people and places.",- "operationId": "getExploreData",- "parameters": [],+ },+ "put": {+ "description": "Update a specific notification to set its read status.",+ "operationId": "updateNotification",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/NotificationUpdateDto"+ }+ }+ },+ "required": true+ },"responses": {"200": {"content": {"application/json": {"schema": {- "items": {- "$ref": "#/components/schemas/SearchExploreResponseDto"- },- "type": "array"+ "$ref": "#/components/schemas/NotificationDto"}}},@@ -11924,9 +11733,9 @@"api_key": []}],- "summary": "Retrieve explore data",+ "summary": "Update a notification","tags": [- "Search"+ "Notifications"],"x-immich-history": [{@@ -11942,52 +11751,2869 @@"state": "Stable"}],- "x-immich-permission": "asset.read",+ "x-immich-permission": "notification.update","x-immich-state": "Stable"}},- "/search/large-assets": {+ "/oauth/authorize": {"post": {- "deprecated": true,- "description": "Search for assets that are considered large based on specified criteria.",- "operationId": "searchLargeAssets",- "parameters": [- {- "name": "albumIds",- "required": false,- "in": "query",- "description": "Filter by album IDs",- "x-immich-history": [- {- "version": "v1",- "state": "Added"- },- {- "version": "v2",- "state": "Stable"- },- {- "version": "v3.2.0",- "state": "Deprecated"- }- ],- "x-immich-state": "Deprecated",- "deprecated": true,- "schema": {- "type": "array",- "items": {- "type": "string",- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$"+ "description": "Initiate the OAuth authorization process.",+ "operationId": "startOAuth",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/OAuthConfigDto"}}},+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/OAuthAuthorizeResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "summary": "Start OAuth",+ "tags": [+ "Authentication"+ ],+ "x-immich-history": [{- "name": "city",- "required": false,- "in": "query",- "description": "Filter by city name",- "x-immich-history": [+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-state": "Stable"+ }+ },+ "/oauth/backchannel-logout": {+ "post": {+ "description": "Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present.",+ "operationId": "logoutOAuth",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/x-www-form-urlencoded": {+ "schema": {+ "$ref": "#/components/schemas/OAuthBackchannelLogoutDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "description": ""+ }+ },+ "summary": "Backchannel OAuth logout",+ "tags": [+ "Authentication"+ ],+ "x-immich-history": [+ {+ "version": "v2",+ "state": "Added"+ }+ ]+ }+ },+ "/oauth/callback": {+ "post": {+ "description": "Complete the OAuth authorization process by exchanging the authorization code for a session token.",+ "operationId": "finishOAuth",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/OAuthCallbackDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/LoginResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "summary": "Finish OAuth",+ "tags": [+ "Authentication"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-state": "Stable"+ }+ },+ "/oauth/link": {+ "post": {+ "description": "Link an OAuth account to the authenticated user.",+ "operationId": "linkOAuthAccount",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/OAuthCallbackDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UserAdminResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Link OAuth account",+ "tags": [+ "Authentication"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-state": "Stable"+ }+ },+ "/oauth/mobile-redirect": {+ "get": {+ "description": "Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.",+ "operationId": "redirectOAuthToMobile",+ "parameters": [],+ "responses": {+ "200": {+ "description": ""+ }+ },+ "summary": "Redirect OAuth to mobile",+ "tags": [+ "Authentication"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-state": "Stable"+ }+ },+ "/oauth/unlink": {+ "post": {+ "description": "Unlink the OAuth account from the authenticated user.",+ "operationId": "unlinkOAuthAccount",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UserAdminResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Unlink OAuth account",+ "tags": [+ "Authentication"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-state": "Stable"+ }+ },+ "/partners": {+ "get": {+ "description": "Retrieve a list of partners with whom assets are shared.",+ "operationId": "getPartners",+ "parameters": [+ {+ "name": "direction",+ "required": true,+ "in": "query",+ "schema": {+ "$ref": "#/components/schemas/PartnerDirection"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/PartnerResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve partners",+ "tags": [+ "Partners"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "partner.read",+ "x-immich-state": "Stable"+ },+ "post": {+ "description": "Create a new partner to share assets with.",+ "operationId": "createPartner",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PartnerCreateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PartnerResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Create a partner",+ "tags": [+ "Partners"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "partner.create",+ "x-immich-state": "Stable"+ }+ },+ "/partners/{id}": {+ "delete": {+ "description": "Stop sharing assets with a partner.",+ "operationId": "removePartner",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Remove a partner",+ "tags": [+ "Partners"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "partner.delete",+ "x-immich-state": "Stable"+ },+ "post": {+ "deprecated": true,+ "description": "Create a new partner to share assets with.",+ "operationId": "createPartnerDeprecated",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PartnerResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Create a partner",+ "tags": [+ "Partners",+ "Deprecated"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Deprecated",+ "replacementId": "createPartner"+ }+ ],+ "x-immich-permission": "partner.create",+ "x-immich-state": "Deprecated"+ },+ "put": {+ "description": "Specify whether a partner's assets should appear in the user's timeline.",+ "operationId": "updatePartner",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PartnerUpdateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PartnerResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Update a partner",+ "tags": [+ "Partners"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "partner.update",+ "x-immich-state": "Stable"+ }+ },+ "/passkeys": {+ "get": {+ "description": "Search the passkeys of the current user.",+ "operationId": "searchPasskeys",+ "parameters": [+ {+ "name": "id",+ "required": false,+ "in": "query",+ "description": "Filter by passkey ID",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/PasskeyResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Search passkeys",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "passkey.read",+ "x-immich-state": "Alpha"+ }+ },+ "/passkeys/authentication/finish": {+ "post": {+ "description": "Verify the response from the authenticator and receive a session token.",+ "operationId": "finishAuthentication",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyAuthenticationFinishDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/LoginResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "summary": "Finish passkey authentication",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-state": "Alpha"+ }+ },+ "/passkeys/authentication/start": {+ "post": {+ "description": "Generate the options used by the browser to sign in with a passkey.",+ "operationId": "startAuthentication",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyAuthenticationOptionsDto"+ }+ }+ },+ "description": ""+ }+ },+ "summary": "Start passkey authentication",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-state": "Alpha"+ }+ },+ "/passkeys/registration/finish": {+ "post": {+ "description": "Verify the response from the authenticator and save the new passkey for the current user.",+ "operationId": "finishRegistration",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyRegistrationFinishDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Finish passkey registration",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-state": "Alpha"+ }+ },+ "/passkeys/registration/start": {+ "post": {+ "description": "Generate the options used by the browser to create a new passkey for the current user.",+ "operationId": "startRegistration",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyRegistrationOptionsDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Start passkey registration",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-state": "Alpha"+ }+ },+ "/passkeys/{id}": {+ "delete": {+ "description": "Delete a passkey by its ID. The current user must own this passkey.",+ "operationId": "deletePasskey",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Delete a passkey",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "passkey.delete",+ "x-immich-state": "Alpha"+ },+ "get": {+ "description": "Retrieve a passkey by its ID. The current user must own this passkey.",+ "operationId": "getPasskey",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve a passkey",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "passkey.read",+ "x-immich-state": "Alpha"+ },+ "patch": {+ "description": "Update the name of a passkey by its ID. The current user must own this passkey.",+ "operationId": "updatePasskey",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyUpdateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PasskeyResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Update a passkey",+ "tags": [+ "Passkeys"+ ],+ "x-immich-history": [+ {+ "version": "v4.0.0",+ "state": "Added"+ },+ {+ "version": "v4.0.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "passkey.update",+ "x-immich-state": "Alpha"+ }+ },+ "/people": {+ "delete": {+ "description": "Bulk delete a list of people at once.",+ "operationId": "deletePeople",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PeopleDeleteDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Delete people",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.delete",+ "x-immich-state": "Stable"+ },+ "get": {+ "description": "Retrieve a list of all people.",+ "operationId": "getAllPeople",+ "parameters": [+ {+ "name": "closestAssetId",+ "required": false,+ "in": "query",+ "description": "Closest asset ID for similarity search",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "closestPersonId",+ "required": false,+ "in": "query",+ "description": "Closest person ID for similarity search",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "isFavorite",+ "required": false,+ "in": "query",+ "description": "Filter by favorite status",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "isHidden",+ "required": false,+ "in": "query",+ "description": "Filter by hidden status",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "name",+ "required": false,+ "in": "query",+ "description": "Filter by person name",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "page",+ "required": false,+ "in": "query",+ "description": "Page number for pagination",+ "schema": {+ "minimum": 1,+ "maximum": 9007199254740991,+ "default": 1,+ "type": "integer"+ }+ },+ {+ "name": "sharedById",+ "required": false,+ "in": "query",+ "description": "Only include people to which the user gave access",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "type": "string"+ }+ },+ {+ "name": "sharedWithId",+ "required": false,+ "in": "query",+ "description": "Only include people to which the user was given access",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "type": "string"+ }+ },+ {+ "name": "size",+ "required": false,+ "in": "query",+ "description": "Number of items per page",+ "schema": {+ "minimum": 1,+ "maximum": 1000,+ "default": 500,+ "type": "integer"+ }+ },+ {+ "name": "withHidden",+ "required": false,+ "in": "query",+ "description": "Include hidden people",+ "schema": {+ "type": "boolean"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PeopleResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Get all people",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.read",+ "x-immich-state": "Stable"+ },+ "post": {+ "description": "Create a new person that can have multiple faces assigned to them.",+ "operationId": "createPerson",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonCreateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "201": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Create a person",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.create",+ "x-immich-state": "Stable"+ },+ "put": {+ "description": "Bulk update multiple people at once.",+ "operationId": "updatePeople",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PeopleUpdateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/BulkIdResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Update people",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.update",+ "x-immich-state": "Stable"+ }+ },+ "/people/merge": {+ "post": {+ "description": "Merge an ordered list of people together into a single person. The final name and birth date are always the first defined value, following the order. Also automatically merges people for other users in the cluster group, skipping people that would result in overriding a previously set name or birth date.",+ "operationId": "mergePeople",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/MergePersonDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/BulkIdResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Merge people",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v3.2.1",+ "state": "Added"+ },+ {+ "version": "v3.2.1",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.merge",+ "x-immich-state": "Stable"+ }+ },+ "/people/users": {+ "delete": {+ "description": "Remove user access to people",+ "operationId": "removeUsersFromPeople",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonUsersDeleteDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Remove users from people",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v3.3.0",+ "state": "Added"+ },+ {+ "version": "v3.3.0",+ "state": "Beta"+ }+ ],+ "x-immich-permission": "person.update",+ "x-immich-state": "Beta"+ },+ "get": {+ "description": "Retrieve a list of users and the people to which they have been given access",+ "operationId": "getUsersForPeople",+ "parameters": [+ {+ "name": "direction",+ "required": false,+ "in": "query",+ "schema": {+ "$ref": "#/components/schemas/SharingDirection"+ }+ },+ {+ "name": "personId",+ "required": false,+ "in": "query",+ "description": "Person ID",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "type": "string"+ }+ },+ {+ "name": "role",+ "required": false,+ "in": "query",+ "description": "Role of user",+ "schema": {+ "$ref": "#/components/schemas/PersonUserRole"+ }+ },+ {+ "name": "sharedById",+ "required": false,+ "in": "query",+ "description": "User ID of the user that gave access",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "type": "string"+ }+ },+ {+ "name": "sharedWithId",+ "required": false,+ "in": "query",+ "description": "User ID of the user that was given access",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonUsersResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Get people access",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v3.3.0",+ "state": "Added"+ },+ {+ "version": "v3.3.0",+ "state": "Beta"+ }+ ],+ "x-immich-permission": "person.read",+ "x-immich-state": "Beta"+ },+ "put": {+ "description": "Give users access to people",+ "operationId": "upsertPeopleUsers",+ "parameters": [],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PeopleUsersUpsertDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Upsert user access",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v3.3.0",+ "state": "Added"+ },+ {+ "version": "v3.3.0",+ "state": "Beta"+ }+ ],+ "x-immich-permission": "person.update",+ "x-immich-state": "Beta"+ }+ },+ "/people/{id}": {+ "delete": {+ "description": "Delete an individual person.",+ "operationId": "deletePerson",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonDeleteDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Delete person",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.delete",+ "x-immich-state": "Stable"+ },+ "get": {+ "description": "Retrieve a person by id.",+ "operationId": "getPerson",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Get a person",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.read",+ "x-immich-state": "Stable"+ },+ "put": {+ "description": "Update an individual person.",+ "operationId": "updatePerson",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonUpdateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Update person",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.0.0",+ "state": "Updated",+ "description": "This endpoint now also supports PATCH, in addition to PUT. PATCH will become the default in v4, and then PUT will be dropped in v5. Please migrate accordingly."+ }+ ],+ "x-immich-permission": "person.update",+ "x-immich-state": "Stable"+ }+ },+ "/people/{id}/merge": {+ "post": {+ "deprecated": true,+ "description": "Merge a list of people into the person specified in the path parameter.",+ "operationId": "mergePersonLegacy",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/MergePersonDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/BulkIdResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Merge people",+ "tags": [+ "People",+ "Deprecated"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.2.1",+ "state": "Deprecated",+ "replacementId": "mergePeople"+ }+ ],+ "x-immich-permission": "person.merge",+ "x-immich-state": "Deprecated"+ }+ },+ "/people/{id}/reassign": {+ "put": {+ "description": "Bulk reassign a list of faces to a different person.",+ "operationId": "reassignFaces",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/AssetFaceUpdateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/PersonResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Reassign faces",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.reassign",+ "x-immich-state": "Stable"+ }+ },+ "/people/{id}/statistics": {+ "get": {+ "description": "Retrieve statistics about a specific person.",+ "operationId": "getPersonStatistics",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PersonStatisticsResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Get person statistics",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.statistics",+ "x-immich-state": "Stable"+ }+ },+ "/people/{id}/thumbnail": {+ "get": {+ "description": "Retrieve the thumbnail file for a person.",+ "operationId": "getPersonThumbnail",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/octet-stream": {+ "schema": {+ "format": "binary",+ "type": "string"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Get person thumbnail",+ "tags": [+ "People"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "person.read",+ "x-immich-state": "Stable"+ }+ },+ "/plugins": {+ "get": {+ "description": "Retrieve a list of plugins available to the authenticated user.",+ "operationId": "searchPlugins",+ "parameters": [+ {+ "name": "description",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "enabled",+ "required": false,+ "in": "query",+ "description": "Whether the plugin is enabled",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "id",+ "required": false,+ "in": "query",+ "description": "Plugin ID",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "name",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "title",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "version",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/PluginResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "List all plugins",+ "tags": [+ "Plugins"+ ],+ "x-immich-history": [+ {+ "version": "v3.0.0",+ "state": "Added"+ }+ ],+ "x-immich-permission": "plugin.read"+ }+ },+ "/plugins/methods": {+ "get": {+ "description": "Retrieve a list of plugin methods",+ "operationId": "searchPluginMethods",+ "parameters": [+ {+ "name": "description",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "enabled",+ "required": false,+ "in": "query",+ "description": "Whether the plugin method is enabled",+ "schema": {+ "type": "boolean"+ }+ },+ {+ "name": "id",+ "required": false,+ "in": "query",+ "description": "Plugin method ID",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ {+ "name": "name",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "pluginName",+ "required": false,+ "in": "query",+ "description": "Plugin name",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "pluginVersion",+ "required": false,+ "in": "query",+ "description": "Plugin version",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "title",+ "required": false,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "trigger",+ "required": false,+ "in": "query",+ "description": "Workflow trigger",+ "schema": {+ "$ref": "#/components/schemas/WorkflowTrigger"+ }+ },+ {+ "name": "type",+ "required": false,+ "in": "query",+ "description": "Workflow types",+ "schema": {+ "$ref": "#/components/schemas/WorkflowType"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/PluginMethodResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve plugin methods",+ "tags": [+ "Plugins"+ ],+ "x-immich-history": [+ {+ "version": "v3.0.0",+ "state": "Added"+ }+ ],+ "x-immich-permission": "plugin.read"+ }+ },+ "/plugins/templates": {+ "get": {+ "description": "Retrieve workflow templates provided by installed plugins",+ "operationId": "searchPluginTemplates",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/PluginTemplateResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve workflow templates",+ "tags": [+ "Plugins"+ ],+ "x-immich-history": [+ {+ "version": "v3.0.0",+ "state": "Added"+ }+ ],+ "x-immich-permission": "plugin.read"+ }+ },+ "/plugins/{id}": {+ "get": {+ "description": "Retrieve information about a specific plugin by its ID.",+ "operationId": "getPlugin",+ "parameters": [+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PluginResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve a plugin",+ "tags": [+ "Plugins"+ ],+ "x-immich-history": [+ {+ "version": "v3.0.0",+ "state": "Added"+ }+ ],+ "x-immich-permission": "plugin.read"+ }+ },+ "/public/config": {+ "get": {+ "description": "Retrieve the system configuration properties that are visible to everyone.",+ "operationId": "getPublicConfig",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PublicConfigDto"+ }+ }+ },+ "description": ""+ }+ },+ "summary": "Get the public configuration",+ "tags": [+ "Config (public)"+ ],+ "x-immich-history": [+ {+ "version": "v3.2.0",+ "state": "Added"+ },+ {+ "version": "v3.2.0",+ "state": "Alpha"+ }+ ],+ "x-immich-state": "Alpha"+ }+ },+ "/public/config/defaults": {+ "get": {+ "description": "Retrieve the default value of the configuration properties that are visible to everyone.",+ "operationId": "getPublicConfigDefaults",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/PublicConfigDto"+ }+ }+ },+ "description": ""+ }+ },+ "summary": "Get the public configuration defaults",+ "tags": [+ "Config (public)"+ ],+ "x-immich-history": [+ {+ "version": "v3.2.0",+ "state": "Added"+ },+ {+ "version": "v3.2.0",+ "state": "Alpha"+ }+ ],+ "x-immich-state": "Alpha"+ }+ },+ "/queues": {+ "get": {+ "description": "Retrieves a list of queues.",+ "operationId": "getQueues",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/QueueResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "List all queues",+ "tags": [+ "Queues"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v2.4.0",+ "state": "Added"+ },+ {+ "version": "v2.4.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "queue.read",+ "x-immich-state": "Alpha"+ }+ },+ "/queues/{name}": {+ "get": {+ "description": "Retrieves a specific queue by its name.",+ "operationId": "getQueue",+ "parameters": [+ {+ "name": "name",+ "required": true,+ "in": "path",+ "schema": {+ "$ref": "#/components/schemas/QueueName"+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/QueueResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve a queue",+ "tags": [+ "Queues"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v2.4.0",+ "state": "Added"+ },+ {+ "version": "v2.4.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "queue.read",+ "x-immich-state": "Alpha"+ },+ "put": {+ "description": "Change the paused status of a specific queue.",+ "operationId": "updateQueue",+ "parameters": [+ {+ "name": "name",+ "required": true,+ "in": "path",+ "schema": {+ "$ref": "#/components/schemas/QueueName"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/QueueUpdateDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/QueueResponseDto"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Update a queue",+ "tags": [+ "Queues"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v2.4.0",+ "state": "Added"+ },+ {+ "version": "v2.4.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "queue.update",+ "x-immich-state": "Alpha"+ }+ },+ "/queues/{name}/jobs": {+ "delete": {+ "description": "Removes all jobs from the specified queue.",+ "operationId": "emptyQueue",+ "parameters": [+ {+ "name": "name",+ "required": true,+ "in": "path",+ "schema": {+ "$ref": "#/components/schemas/QueueName"+ }+ }+ ],+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/QueueDeleteDto"+ }+ }+ },+ "required": true+ },+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Empty a queue",+ "tags": [+ "Queues"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v2.4.0",+ "state": "Added"+ },+ {+ "version": "v2.4.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "queueJob.delete",+ "x-immich-state": "Alpha"+ },+ "get": {+ "description": "Retrieves a list of queue jobs from the specified queue.",+ "operationId": "getQueueJobs",+ "parameters": [+ {+ "name": "name",+ "required": true,+ "in": "path",+ "schema": {+ "$ref": "#/components/schemas/QueueName"+ }+ },+ {+ "name": "status",+ "required": false,+ "in": "query",+ "description": "Filter jobs by status",+ "schema": {+ "type": "array",+ "items": {+ "$ref": "#/components/schemas/QueueJobStatus"+ }+ }+ }+ ],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/QueueJobResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve queue jobs",+ "tags": [+ "Queues"+ ],+ "x-immich-admin-only": true,+ "x-immich-history": [+ {+ "version": "v2.4.0",+ "state": "Added"+ },+ {+ "version": "v2.4.0",+ "state": "Alpha"+ }+ ],+ "x-immich-permission": "queueJob.read",+ "x-immich-state": "Alpha"+ }+ },+ "/search/cities": {+ "get": {+ "description": "Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.",+ "operationId": "getAssetsByCity",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/AssetResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve assets by city",+ "tags": [+ "Search"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "asset.read",+ "x-immich-state": "Stable"+ }+ },+ "/search/explore": {+ "get": {+ "description": "Retrieve data for the explore section, such as popular people and places.",+ "operationId": "getExploreData",+ "parameters": [],+ "responses": {+ "200": {+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/SearchExploreResponseDto"+ },+ "type": "array"+ }+ }+ },+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "summary": "Retrieve explore data",+ "tags": [+ "Search"+ ],+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v1",+ "state": "Beta"+ },+ {+ "version": "v2",+ "state": "Stable"+ }+ ],+ "x-immich-permission": "asset.read",+ "x-immich-state": "Stable"+ }+ },+ "/search/large-assets": {+ "post": {+ "deprecated": true,+ "description": "Search for assets that are considered large based on specified criteria.",+ "operationId": "searchLargeAssets",+ "parameters": [+ {+ "name": "albumIds",+ "required": false,+ "in": "query",+ "description": "Filter by album IDs",+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.2.0",+ "state": "Deprecated"+ }+ ],+ "x-immich-state": "Deprecated",+ "deprecated": true,+ "schema": {+ "type": "array",+ "items": {+ "type": "string",+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$"+ }+ }+ },+ {+ "name": "city",+ "required": false,+ "in": "query",+ "description": "Filter by city name",+ "x-immich-history": [{"version": "v1","state": "Added"@@ -18626,6 +21252,10 @@"name": "Authentication (admin)","description": "Administrative endpoints related to authentication."},+ {+ "name": "Backups",+ "description": "FUTO Backups."+ },{"name": "Cluster groups","description": "A cluster group is a set of users whose faces are clustered together, so that a person can be shared between them."@@ -18911,6 +21541,10 @@},"AdminConfigBackupsDto": {"properties": {+ "beta": {+ "description": "Whether the backups feature is enabled",+ "type": "boolean"+ },"database": {"$ref": "#/components/schemas/AdminConfigDatabaseBackupDto"}@@ -21962,6 +24596,92 @@},"type": "object"},+ "BackendDto": {+ "properties": {+ "description": {+ "type": "string"+ },+ "error": {+ "type": "string"+ },+ "id": {+ "type": "string"+ },+ "isOnline": {+ "type": "boolean"+ },+ "type": {+ "$ref": "#/components/schemas/BackendType"+ }+ },+ "required": [+ "description",+ "id",+ "isOnline",+ "type"+ ],+ "type": "object"+ },+ "BackendResponseDto": {+ "properties": {+ "backend": {+ "$ref": "#/components/schemas/BackendDto"+ }+ },+ "required": [+ "backend"+ ],+ "type": "object"+ },+ "BackendType": {+ "enum": [+ "yucca",+ "local",+ "s3"+ ],+ "type": "string"+ },+ "BackendsResponseDto": {+ "properties": {+ "backends": {+ "items": {+ "$ref": "#/components/schemas/BackendDto"+ },+ "type": "array"+ }+ },+ "required": [+ "backends"+ ],+ "type": "object"+ },+ "BackupStatus": {+ "enum": [+ "incomplete",+ "complete",+ "warn",+ "failed",+ "cancelled"+ ],+ "type": "string"+ },+ "BandwidthDto": {+ "properties": {+ "bytesPerSec": {+ "maximum": 9007199254740991,+ "minimum": 0,+ "type": "integer"+ },+ "quietHours": {+ "pattern": "^([01]\\d|2[0-3]):[0-5]\\d-([01]\\d|2[0-3]):[0-5]\\d$",+ "type": "string"+ }+ },+ "required": [+ "bytesPerSec"+ ],+ "type": "object"+ },"BoolFilter": {"properties": {"eq": {@@ -21973,6 +24693,14 @@],"type": "object"},+ "BootstrapStatus": {+ "enum": [+ "not-ready",+ "ready",+ "error"+ ],+ "type": "string"+ },"BulkIdErrorReason": {"description": "Error reason","enum": [@@ -22168,34 +24896,132 @@"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","type": "string"},- "id": {- "description": "Request ID",- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"+ "id": {+ "description": "Request ID",+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ },+ "userId": {+ "description": "User the request was created for",+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ "required": [+ "clusterGroupId",+ "createdAt",+ "id",+ "userId"+ ],+ "type": "object"+ },+ "Colorspace": {+ "description": "Colorspace",+ "enum": [+ "srgb",+ "p3"+ ],+ "type": "string"+ },+ "ConfigResponseDto": {+ "properties": {+ "bandwidth": {+ "$ref": "#/components/schemas/BandwidthDto"+ }+ },+ "required": [+ "bandwidth"+ ],+ "type": "object"+ },+ "ConfigUpdateRequestDto": {+ "properties": {+ "bandwidth": {+ "$ref": "#/components/schemas/BandwidthDto"+ }+ },+ "required": [+ "bandwidth"+ ],+ "type": "object"+ },+ "ConfigureImmichDatabaseDumpRequestDto": {+ "properties": {+ "enabled": {+ "type": "boolean"+ },+ "keepLastAmount": {+ "maximum": 9007199254740991,+ "minimum": 1,+ "type": "integer"+ }+ },+ "type": "object"+ },+ "ConfigureImmichIntegrationRequestDto": {+ "properties": {+ "backupConfiguration": {+ "type": "boolean"+ },+ "cron": {+ "type": "string"+ },+ "dataFolders": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "libraries": {+ "description": "IDs of the external libraries to back up. Use [\"all\"] to back up every library, including ones added later.",+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "name": {+ "type": "string"+ },+ "paused": {+ "type": "boolean"},- "userId": {- "description": "User the request was created for",- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "repositoryId": {"type": "string"+ },+ "retentionPolicy": {+ "allOf": [+ {+ "$ref": "#/components/schemas/RetentionPolicyDto"+ }+ ],+ "nullable": true+ },+ "worm": {+ "type": "boolean"}},"required": [- "clusterGroupId",- "createdAt",- "id",- "userId"+ "backupConfiguration",+ "cron",+ "dataFolders",+ "libraries",+ "name",+ "worm"],"type": "object"},- "Colorspace": {- "description": "Colorspace",- "enum": [- "srgb",- "p3"+ "ConfigureImmichIntegrationResponseDto": {+ "properties": {+ "repositoryId": {+ "type": "string"+ }+ },+ "required": [+ "repositoryId"],- "type": "string"+ "type": "object"},"ContributorCountResponseDto": {"properties": {@@ -22297,6 +25123,17 @@],"type": "object"},+ "CreateLocalBackendRequestDto": {+ "properties": {+ "path": {+ "type": "string"+ }+ },+ "required": [+ "path"+ ],+ "type": "object"+ },"CreateProfileImageDto": {"properties": {"file": {@@ -22337,6 +25174,17 @@],"type": "object"},+ "CreateSessionRequestDto": {+ "properties": {+ "token": {+ "type": "string"+ }+ },+ "required": [+ "token"+ ],+ "type": "object"+ },"CropParameters": {"properties": {"height": {@@ -22372,6 +25220,17 @@],"type": "object"},+ "CurrentRecoveryKeyResponse": {+ "properties": {+ "recoveryKey": {+ "type": "string"+ }+ },+ "required": [+ "recoveryKey"+ ],+ "type": "object"+ },"DatabaseBackupDeleteDto": {"properties": {"backups": {@@ -22520,6 +25379,49 @@},"type": "object"},+ "DeviceFlowEventDto": {+ "properties": {+ "backendId": {+ "type": "string"+ },+ "reason": {+ "$ref": "#/components/schemas/DeviceFlowFailureReason"+ },+ "token": {+ "type": "string"+ },+ "type": {+ "$ref": "#/components/schemas/DeviceFlowEventType"+ },+ "userCode": {+ "type": "string"+ },+ "verificationUri": {+ "type": "string"+ }+ },+ "required": [+ "type"+ ],+ "type": "object"+ },+ "DeviceFlowEventType": {+ "enum": [+ "START",+ "SUCCESS",+ "FAILURE"+ ],+ "type": "string"+ },+ "DeviceFlowFailureReason": {+ "enum": [+ "NOT_CONNECTED",+ "DEVICE_FLOW_FAILED",+ "WRONG_ACCOUNT",+ "UNKNOWN"+ ],+ "type": "string"+ },"DownloadArchiveDto": {"properties": {"archiveName": {@@ -22995,6 +25897,43 @@],"type": "object"},+ "FilesystemListingItemDto": {+ "properties": {+ "isDirectory": {+ "type": "boolean"+ },+ "path": {+ "type": "string"+ }+ },+ "required": [+ "isDirectory",+ "path"+ ],+ "type": "object"+ },+ "FilesystemListingResponseDto": {+ "properties": {+ "items": {+ "items": {+ "$ref": "#/components/schemas/FilesystemListingItemDto"+ },+ "type": "array"+ },+ "parent": {+ "type": "string"+ },+ "path": {+ "type": "string"+ }+ },+ "required": [+ "items",+ "parent",+ "path"+ ],+ "type": "object"+ },"FoldersResponse": {"properties": {"enabled": {@@ -23051,63 +25990,293 @@},"type": "object"},- "IdFilterNullable": {+ "IdFilterNullable": {+ "properties": {+ "eq": {+ "format": "uuid",+ "nullable": true,+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ },+ "ne": {+ "format": "uuid",+ "nullable": true,+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ }+ },+ "type": "object"+ },+ "IdsFilter": {+ "properties": {+ "all": {+ "items": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ },+ "minItems": 1,+ "type": "array"+ },+ "any": {+ "items": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ },+ "minItems": 1,+ "type": "array"+ },+ "none": {+ "items": {+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "type": "string"+ },+ "minItems": 1,+ "type": "array"+ }+ },+ "type": "object"+ },+ "ImageFormat": {+ "description": "Image format",+ "enum": [+ "jpeg",+ "jxl",+ "webp"+ ],+ "type": "string"+ },+ "ImmichBackupStatusDto": {+ "properties": {+ "backend": {+ "$ref": "#/components/schemas/BackendDto"+ },+ "databaseDump": {+ "$ref": "#/components/schemas/ImmichDatabaseDumpConfigDto"+ },+ "databaseDumpWarningIgnored": {+ "type": "boolean"+ },+ "integration": {+ "$ref": "#/components/schemas/ImmichIntegrationDto"+ },+ "latestBackupJob": {+ "$ref": "#/components/schemas/JobDto"+ },+ "repository": {+ "$ref": "#/components/schemas/LocalRepositoryDto"+ },+ "schedule": {+ "$ref": "#/components/schemas/ScheduleDto"+ }+ },+ "type": "object"+ },+ "ImmichDatabaseDumpConfigDto": {+ "properties": {+ "enabled": {+ "type": "boolean"+ },+ "keepLastAmount": {+ "maximum": 9007199254740991,+ "minimum": 1,+ "type": "integer"+ }+ },+ "required": [+ "enabled",+ "keepLastAmount"+ ],+ "type": "object"+ },+ "ImmichIntegrationConfigurationDto": {+ "properties": {+ "backupConfiguration": {+ "type": "boolean"+ },+ "dataFolders": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "libraries": {+ "description": "IDs of the external libraries to back up. Use [\"all\"] to back up every library, including ones added later.",+ "items": {+ "type": "string"+ },+ "type": "array"+ }+ },+ "required": [+ "backupConfiguration",+ "dataFolders",+ "libraries"+ ],+ "type": "object"+ },+ "ImmichIntegrationDto": {+ "properties": {+ "configuration": {+ "$ref": "#/components/schemas/ImmichIntegrationConfigurationDto"+ },+ "id": {+ "type": "string"+ },+ "scheduleId": {+ "type": "string"+ }+ },+ "required": [+ "configuration",+ "id",+ "scheduleId"+ ],+ "type": "object"+ },+ "ImmichLibraryDto": {+ "properties": {+ "exclusionPatterns": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "id": {+ "type": "string"+ },+ "importPaths": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "name": {+ "type": "string"+ }+ },+ "required": [+ "exclusionPatterns",+ "id",+ "importPaths",+ "name"+ ],+ "type": "object"+ },+ "ImmichRollbackRequestDto": {"properties": {- "eq": {- "format": "uuid",- "nullable": true,- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "backupFileName": {"type": "string"},- "ne": {- "format": "uuid",- "nullable": true,- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",+ "repositoryId": {+ "type": "string"+ },+ "snapshotId": {"type": "string"}},+ "required": [+ "repositoryId",+ "snapshotId"+ ],"type": "object"},- "IdsFilter": {+ "ImmichStateDto": {"properties": {- "all": {+ "dataFolders": {"items": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","type": "string"},- "minItems": 1,"type": "array"},- "any": {+ "dataPath": {+ "type": "string"+ },+ "libraries": {"items": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"+ "$ref": "#/components/schemas/ImmichLibraryDto"},- "minItems": 1,"type": "array"+ }+ },+ "required": [+ "dataFolders",+ "dataPath",+ "libraries"+ ],+ "type": "object"+ },+ "ImportRecoveryKeyRequest": {+ "properties": {+ "recoveryKey": {+ "type": "string"+ }+ },+ "required": [+ "recoveryKey"+ ],+ "type": "object"+ },+ "InspectedLocalRepositoryDto": {+ "properties": {+ "backends": {+ "$ref": "#/components/schemas/RepositoryBackendsDto"},- "none": {+ "configuration": {+ "$ref": "#/components/schemas/RepositoryConfigurationDto"+ },+ "id": {+ "type": "string"+ },+ "meter": {+ "$ref": "#/components/schemas/RepositoryMeterDto"+ },+ "metrics": {+ "$ref": "#/components/schemas/RepositoryMetricsDto"+ },+ "name": {+ "type": "string"+ },+ "siteCode": {+ "nullable": true,+ "type": "string"+ },+ "snapshots": {"items": {- "format": "uuid",- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",- "type": "string"+ "$ref": "#/components/schemas/SnapshotDto"},- "minItems": 1,"type": "array"+ },+ "storageClusterCode": {+ "nullable": true,+ "type": "string"+ },+ "worm": {+ "type": "boolean"}},+ "required": [+ "id",+ "metrics",+ "name",+ "siteCode",+ "storageClusterCode",+ "worm"+ ],"type": "object"},- "ImageFormat": {- "description": "Image format",- "enum": [- "jpeg",- "jxl",- "webp"- ],- "type": "string"+ "IntegrationsResponseDto": {+ "properties": {+ "immichIntegration": {+ "$ref": "#/components/schemas/ImmichIntegrationDto"+ },+ "immichState": {+ "$ref": "#/components/schemas/ImmichStateDto"+ }+ },+ "type": "object"},"IntegrityReport": {"description": "Integrity report type",@@ -23191,6 +26360,59 @@],"type": "object"},+ "JobDto": {+ "properties": {+ "end": {+ "type": "string"+ },+ "id": {+ "type": "string"+ },+ "name": {+ "$ref": "#/components/schemas/YuccaJobName"+ },+ "outcome": {+ "$ref": "#/components/schemas/JobOutcomeDto"+ },+ "progress": {+ "$ref": "#/components/schemas/JobProgressDto"+ },+ "queuedAt": {+ "type": "string"+ },+ "repositoryId": {+ "type": "string"+ },+ "start": {+ "type": "string"+ },+ "status": {+ "$ref": "#/components/schemas/YuccaJobStatus"+ }+ },+ "required": [+ "id",+ "name",+ "queuedAt",+ "repositoryId",+ "status"+ ],+ "type": "object"+ },+ "JobListResponseDto": {+ "properties": {+ "jobs": {+ "items": {+ "$ref": "#/components/schemas/JobDto"+ },+ "type": "array"+ }+ },+ "required": [+ "jobs"+ ],+ "type": "object"+ },"JobName": {"description": "Job name","enum": [@@ -23264,6 +26486,201 @@],"type": "string"},+ "JobOutcomeDto": {+ "properties": {+ "errors": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "summary": {+ "$ref": "#/components/schemas/JobSummaryDto"+ },+ "support": {+ "$ref": "#/components/schemas/JobSupportDto"+ }+ },+ "required": [+ "errors"+ ],+ "type": "object"+ },+ "JobProgressDto": {+ "properties": {+ "bytesDone": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "currentFiles": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "estimatedEndAt": {+ "type": "string"+ },+ "percentDone": {+ "format": "double",+ "type": "number"+ },+ "scanning": {+ "type": "boolean"+ },+ "totalBytes": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ }+ },+ "required": [+ "currentFiles",+ "percentDone",+ "scanning"+ ],+ "type": "object"+ },+ "JobResponseDto": {+ "properties": {+ "jobId": {+ "type": "string"+ }+ },+ "required": [+ "jobId"+ ],+ "type": "object"+ },+ "JobSummaryDto": {+ "oneOf": [+ {+ "type": "object",+ "properties": {+ "type": {+ "type": "string",+ "enum": [+ "backup"+ ]+ },+ "filesNew": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "filesChanged": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "totalFilesProcessed": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "totalBytesProcessed": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "snapshotId": {+ "type": "string"+ }+ },+ "required": [+ "type",+ "filesNew",+ "filesChanged",+ "totalFilesProcessed",+ "totalBytesProcessed"+ ]+ },+ {+ "type": "object",+ "properties": {+ "type": {+ "type": "string",+ "enum": [+ "restore"+ ]+ },+ "filesRestored": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "filesSkipped": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "bytesRestored": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ }+ },+ "required": [+ "type",+ "filesRestored",+ "filesSkipped",+ "bytesRestored"+ ]+ },+ {+ "type": "object",+ "properties": {+ "type": {+ "type": "string",+ "enum": [+ "prune"+ ]+ },+ "kept": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ },+ "removed": {+ "type": "integer",+ "minimum": -9007199254740991,+ "maximum": 9007199254740991+ }+ },+ "required": [+ "type",+ "kept",+ "removed"+ ]+ }+ ]+ },+ "JobSupportDto": {+ "properties": {+ "droppedLines": {+ "description": "Log lines that could not be streamed in time",+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "localDroppedLines": {+ "description": "Log lines that could not be written to the local support log",+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "sessionId": {+ "description": "Support code to share with FUTO when the logs were streamed",+ "type": "string"+ }+ },+ "required": [+ "droppedLines",+ "localDroppedLines"+ ],+ "type": "object"+ },"LibraryResponseDto": {"properties": {"assetCount": {@@ -23391,9 +26808,65 @@],"type": "object"},- "LicenseResponseDto": {- "$ref": "#/components/schemas/UserLicense"- },+ "LicenseResponseDto": {+ "$ref": "#/components/schemas/UserLicense"+ },+ "ListSnapshotsResponseDto": {+ "properties": {+ "snapshots": {+ "items": {+ "$ref": "#/components/schemas/SnapshotDto"+ },+ "type": "array"+ }+ },+ "required": [+ "snapshots"+ ],+ "type": "object"+ },+ "LocalRepositoryDto": {+ "properties": {+ "backends": {+ "$ref": "#/components/schemas/RepositoryBackendsDto"+ },+ "configuration": {+ "$ref": "#/components/schemas/RepositoryConfigurationDto"+ },+ "id": {+ "type": "string"+ },+ "meter": {+ "$ref": "#/components/schemas/RepositoryMeterDto"+ },+ "metrics": {+ "$ref": "#/components/schemas/RepositoryMetricsDto"+ },+ "name": {+ "type": "string"+ },+ "siteCode": {+ "nullable": true,+ "type": "string"+ },+ "storageClusterCode": {+ "nullable": true,+ "type": "string"+ },+ "worm": {+ "type": "boolean"+ }+ },+ "required": [+ "id",+ "metrics",+ "name",+ "siteCode",+ "storageClusterCode",+ "worm"+ ],+ "type": "object"+ },"LogLevel": {"description": "Log level","enum": [@@ -23501,7 +26974,8 @@"start","end","select_database_restore",- "restore_database"+ "restore_database",+ "rollback"],"type": "string"},@@ -23579,6 +27053,10 @@"error": {"type": "string"},+ "futoBackupsJobId": {+ "description": "FUTO Backups job ID",+ "type": "string"+ },"progress": {"maximum": 9007199254740991,"minimum": -9007199254740991,@@ -25259,6 +28737,52 @@],"type": "object"},+ "OnboardingStatusResponseDto": {+ "properties": {+ "error": {+ "type": "string"+ },+ "hasBackend": {+ "type": "boolean"+ },+ "hasBackup": {+ "type": "boolean"+ },+ "hasOnboardedKey": {+ "type": "boolean"+ },+ "hasSchedule": {+ "type": "boolean"+ },+ "hasSkippedExtraConfig": {+ "type": "boolean"+ },+ "hasTelemetry": {+ "$ref": "#/components/schemas/TelemetryLevel"+ },+ "isAuthenticated": {+ "type": "boolean"+ },+ "requiresAuthentication": {+ "type": "boolean"+ },+ "status": {+ "$ref": "#/components/schemas/BootstrapStatus"+ }+ },+ "required": [+ "hasBackend",+ "hasBackup",+ "hasOnboardedKey",+ "hasSchedule",+ "hasSkippedExtraConfig",+ "hasTelemetry",+ "isAuthenticated",+ "requiresAuthentication",+ "status"+ ],+ "type": "object"+ },"PartnerCreateDto": {"properties": {"sharedWithId": {@@ -27559,222 +31083,655 @@],"x-immich-state": "Deprecated"},- "updatedBefore": {- "deprecated": true,- "description": "Filter by update date (before)",- "example": "2024-01-01T00:00:00.000Z",- "format": "date-time",- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",- "type": "string",- "x-immich-history": [- {- "version": "v1",- "state": "Added"- },- {- "version": "v2",- "state": "Stable"- },+ "updatedBefore": {+ "deprecated": true,+ "description": "Filter by update date (before)",+ "example": "2024-01-01T00:00:00.000Z",+ "format": "date-time",+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",+ "type": "string",+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.2.0",+ "state": "Deprecated"+ }+ ],+ "x-immich-state": "Deprecated"+ },+ "visibility": {+ "$ref": "#/components/schemas/AssetVisibility",+ "deprecated": true,+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.2.0",+ "state": "Deprecated"+ }+ ],+ "x-immich-state": "Deprecated"+ },+ "withDeleted": {+ "deprecated": true,+ "description": "Include deleted assets",+ "type": "boolean",+ "x-immich-history": [+ {+ "version": "v1",+ "state": "Added"+ },+ {+ "version": "v2",+ "state": "Stable"+ },+ {+ "version": "v3.2.0",+ "state": "Deprecated"+ }+ ],+ "x-immich-state": "Deprecated"+ },+ "withExif": {+ "description": "Include EXIF data in response",+ "type": "boolean"+ },+ "withPeople": {+ "description": "Include people data in response",+ "type": "boolean"+ },+ "withStacked": {+ "description": "Include stacked assets",+ "type": "boolean"+ }+ },+ "type": "object"+ },+ "RatingsResponse": {+ "properties": {+ "enabled": {+ "description": "Whether ratings are enabled",+ "type": "boolean"+ }+ },+ "required": [+ "enabled"+ ],+ "type": "object"+ },+ "RatingsUpdate": {+ "properties": {+ "enabled": {+ "description": "Whether ratings are enabled",+ "type": "boolean"+ }+ },+ "type": "object"+ },+ "ReactionLevel": {+ "description": "Reaction level",+ "enum": [+ "album",+ "asset"+ ],+ "type": "string"+ },+ "ReactionType": {+ "description": "Reaction type",+ "enum": [+ "comment",+ "like"+ ],+ "type": "string"+ },+ "RecentlyAddedResponse": {+ "properties": {+ "sidebarWeb": {+ "description": "Whether the recently added page appears in the web sidebar",+ "type": "boolean"+ }+ },+ "required": [+ "sidebarWeb"+ ],+ "type": "object"+ },+ "RecentlyAddedUpdate": {+ "properties": {+ "sidebarWeb": {+ "description": "Whether the recently added page appears in the web sidebar",+ "type": "boolean"+ }+ },+ "type": "object"+ },+ "ReleaseChannel": {+ "description": "Release channel",+ "enum": [+ "stable",+ "releaseCandidate"+ ],+ "type": "string"+ },+ "ReleaseEventV1": {+ "properties": {+ "checkedAt": {+ "description": "When the server last checked for a latest version. As an ISO timestamp",+ "type": "string"+ },+ "isAvailable": {+ "description": "Whether a new version is available",+ "type": "boolean"+ },+ "releaseVersion": {+ "$ref": "#/components/schemas/ServerVersionResponseDto"+ },+ "serverVersion": {+ "$ref": "#/components/schemas/ServerVersionResponseDto"+ },+ "type": {+ "$ref": "#/components/schemas/ReleaseType",+ "description": "Release type",+ "nullable": true+ }+ },+ "required": [+ "checkedAt",+ "isAvailable",+ "releaseVersion",+ "serverVersion",+ "type"+ ],+ "type": "object"+ },+ "ReleaseType": {+ "enum": [+ "major",+ "premajor",+ "minor",+ "preminor",+ "patch",+ "prepatch",+ "prerelease"+ ],+ "type": "string"+ },+ "RepositoryBackendDto": {+ "properties": {+ "id": {+ "type": "string"+ },+ "online": {+ "type": "boolean"+ },+ "type": {+ "$ref": "#/components/schemas/BackendType"+ }+ },+ "required": [+ "id",+ "online",+ "type"+ ],+ "type": "object"+ },+ "RepositoryBackendsDto": {+ "properties": {+ "primary": {+ "$ref": "#/components/schemas/RepositoryBackendDto"+ },+ "secondary": {+ "items": {+ "$ref": "#/components/schemas/RepositoryBackendDto"+ },+ "type": "array"+ }+ },+ "required": [+ "primary",+ "secondary"+ ],+ "type": "object"+ },+ "RepositoryCheckImportResponseDto": {+ "properties": {+ "readable": {+ "type": "boolean"+ }+ },+ "required": [+ "readable"+ ],+ "type": "object"+ },+ "RepositoryConfigurationDto": {+ "properties": {+ "paths": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "retentionPolicy": {+ "allOf": [{- "version": "v3.2.0",- "state": "Deprecated"+ "$ref": "#/components/schemas/RetentionPolicyDto"}],- "x-immich-state": "Deprecated"+ "nullable": true+ }+ },+ "required": [+ "paths"+ ],+ "type": "object"+ },+ "RepositoryCreateRequestDto": {+ "properties": {+ "name": {+ "type": "string"},- "visibility": {- "$ref": "#/components/schemas/AssetVisibility",- "deprecated": true,- "x-immich-history": [- {- "version": "v1",- "state": "Added"- },- {- "version": "v2",- "state": "Stable"- },+ "paths": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "retentionPolicy": {+ "allOf": [{- "version": "v3.2.0",- "state": "Deprecated"+ "$ref": "#/components/schemas/RetentionPolicyDto"}],- "x-immich-state": "Deprecated"+ "nullable": true},- "withDeleted": {- "deprecated": true,- "description": "Include deleted assets",- "type": "boolean",- "x-immich-history": [- {- "version": "v1",- "state": "Added"- },- {- "version": "v2",- "state": "Stable"- },+ "site": {+ "description": "Internal site code from environment metadata",+ "type": "string"+ },+ "worm": {+ "type": "boolean"+ }+ },+ "required": [+ "name",+ "worm"+ ],+ "type": "object"+ },+ "RepositoryCreateResponseDto": {+ "properties": {+ "repository": {+ "$ref": "#/components/schemas/LocalRepositoryDto"+ }+ },+ "required": [+ "repository"+ ],+ "type": "object"+ },+ "RepositoryInspectResponseDto": {+ "properties": {+ "repositories": {+ "items": {+ "$ref": "#/components/schemas/InspectedLocalRepositoryDto"+ },+ "type": "array"+ }+ },+ "required": [+ "repositories"+ ],+ "type": "object"+ },+ "RepositoryListResponseDto": {+ "properties": {+ "repositories": {+ "items": {+ "$ref": "#/components/schemas/LocalRepositoryDto"+ },+ "type": "array"+ }+ },+ "required": [+ "repositories"+ ],+ "type": "object"+ },+ "RepositoryMeterDto": {+ "properties": {+ "lastUpdated": {+ "nullable": true,+ "type": "string"+ },+ "objectCount": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "sizeBytes": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ }+ },+ "required": [+ "objectCount",+ "sizeBytes"+ ],+ "type": "object"+ },+ "RepositoryMetricsDto": {+ "properties": {+ "lastBackup": {+ "nullable": true,+ "type": "string"+ },+ "lastBackupDuration": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "nullable": true,+ "type": "integer"+ },+ "lastBackupStatus": {+ "allOf": [{- "version": "v3.2.0",- "state": "Deprecated"+ "$ref": "#/components/schemas/BackupStatus"}],- "x-immich-state": "Deprecated"+ "nullable": true},- "withExif": {- "description": "Include EXIF data in response",- "type": "boolean"+ "lastStarted": {+ "nullable": true,+ "type": "string"},- "withPeople": {- "description": "Include people data in response",- "type": "boolean"+ "sizeBytes": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ }+ },+ "required": [+ "sizeBytes"+ ],+ "type": "object"+ },+ "RepositoryPrimaryBackendReconfigureRequestDto": {+ "properties": {+ "backendId": {+ "type": "string"+ }+ },+ "required": [+ "backendId"+ ],+ "type": "object"+ },+ "RepositorySnapshotRestoreFromPointRequestDto": {+ "properties": {+ "include": {+ "items": {+ "type": "string"+ },+ "type": "array"},- "withStacked": {- "description": "Include stacked assets",- "type": "boolean"+ "yuccaConfig": {+ "type": "string"}},"type": "object"},- "RatingsResponse": {+ "RepositorySnapshotRestoreRequestDto": {"properties": {- "enabled": {- "description": "Whether ratings are enabled",+ "include": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "target": {+ "type": "string"+ }+ },+ "type": "object"+ },+ "RepositorySyncDeletionResponseDto": {+ "properties": {+ "deleted": {+ "description": "Whether the repository was deleted remotely and removed from this server","type": "boolean"}},"required": [- "enabled"+ "deleted"],"type": "object"},- "RatingsUpdate": {+ "RepositoryUpdateRequestDto": {"properties": {- "enabled": {- "description": "Whether ratings are enabled",+ "name": {+ "type": "string"+ },+ "paths": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "retentionPolicy": {+ "allOf": [+ {+ "$ref": "#/components/schemas/RetentionPolicyDto"+ }+ ],+ "nullable": true+ },+ "worm": {"type": "boolean"}},"type": "object"},- "ReactionLevel": {- "description": "Reaction level",- "enum": [- "album",- "asset"+ "RepositoryUpdateResponseDto": {+ "properties": {+ "repository": {+ "$ref": "#/components/schemas/LocalRepositoryDto"+ }+ },+ "required": [+ "repository"],- "type": "string"+ "type": "object"},- "ReactionType": {- "description": "Reaction type",- "enum": [- "comment",- "like"+ "RetentionPolicyDto": {+ "properties": {+ "keepLast": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "keepWithin": {+ "type": "string"+ },+ "keepWithinDaily": {+ "type": "string"+ },+ "keepWithinHourly": {+ "type": "string"+ },+ "keepWithinMonthly": {+ "type": "string"+ },+ "keepWithinWeekly": {+ "type": "string"+ },+ "keepWithinYearly": {+ "type": "string"+ }+ },+ "type": "object"+ },+ "ReverseGeocodingStateResponseDto": {+ "properties": {+ "lastImportFileName": {+ "description": "Last import file name",+ "nullable": true,+ "type": "string"+ },+ "lastUpdate": {+ "description": "Last update timestamp",+ "nullable": true,+ "type": "string"+ }+ },+ "required": [+ "lastImportFileName",+ "lastUpdate"],- "type": "string"+ "type": "object"},- "RecentlyAddedResponse": {+ "RotateParameters": {"properties": {- "sidebarWeb": {- "description": "Whether the recently added page appears in the web sidebar",- "type": "boolean"+ "angle": {+ "description": "Rotation angle in degrees",+ "maximum": 270,+ "minimum": 0,+ "type": "integer"}},"required": [- "sidebarWeb"+ "angle"],"type": "object"},- "RecentlyAddedUpdate": {+ "ScheduleCreateRequestDto": {"properties": {- "sidebarWeb": {- "description": "Whether the recently added page appears in the web sidebar",+ "cron": {+ "type": "string"+ },+ "name": {+ "type": "string"+ },+ "paused": {+ "default": false,"type": "boolean"+ },+ "repositories": {+ "items": {+ "type": "string"+ },+ "type": "array"}},+ "required": [+ "cron",+ "name",+ "repositories"+ ],"type": "object"},- "ReleaseChannel": {- "description": "Release channel",- "enum": [- "stable",- "releaseCandidate"+ "ScheduleCreateResponseDto": {+ "properties": {+ "schedule": {+ "$ref": "#/components/schemas/ScheduleDto"+ }+ },+ "required": [+ "schedule"],- "type": "string"+ "type": "object"},- "ReleaseEventV1": {+ "ScheduleDto": {"properties": {- "checkedAt": {- "description": "When the server last checked for a latest version. As an ISO timestamp",+ "cron": {"type": "string"},- "isAvailable": {- "description": "Whether a new version is available",- "type": "boolean"+ "id": {+ "type": "string"},- "releaseVersion": {- "$ref": "#/components/schemas/ServerVersionResponseDto"+ "lastFinished": {+ "type": "string"},- "serverVersion": {- "$ref": "#/components/schemas/ServerVersionResponseDto"+ "lastRun": {+ "type": "string"},- "type": {- "$ref": "#/components/schemas/ReleaseType",- "description": "Release type",- "nullable": true+ "name": {+ "type": "string"+ },+ "paused": {+ "type": "boolean"+ },+ "repositories": {+ "items": {+ "type": "string"+ },+ "type": "array"}},"required": [- "checkedAt",- "isAvailable",- "releaseVersion",- "serverVersion",- "type"+ "cron",+ "id",+ "name",+ "paused",+ "repositories"],"type": "object"},- "ReleaseType": {- "enum": [- "major",- "premajor",- "minor",- "preminor",- "patch",- "prepatch",- "prerelease"+ "ScheduleListResponseDto": {+ "properties": {+ "schedules": {+ "items": {+ "$ref": "#/components/schemas/ScheduleDto"+ },+ "type": "array"+ }+ },+ "required": [+ "schedules"],- "type": "string"+ "type": "object"},- "ReverseGeocodingStateResponseDto": {+ "ScheduleUpdateRequestDto": {"properties": {- "lastImportFileName": {- "description": "Last import file name",- "nullable": true,+ "cron": {"type": "string"},- "lastUpdate": {- "description": "Last update timestamp",- "nullable": true,+ "name": {"type": "string"+ },+ "paused": {+ "type": "boolean"+ },+ "repositories": {+ "items": {+ "type": "string"+ },+ "type": "array"}},- "required": [- "lastImportFileName",- "lastUpdate"- ],"type": "object"},- "RotateParameters": {+ "ScheduleUpdateResponseDto": {"properties": {- "angle": {- "description": "Rotation angle in degrees",- "maximum": 270,- "minimum": 0,- "type": "integer"+ "schedule": {+ "$ref": "#/components/schemas/ScheduleDto"}},"required": [- "angle"+ "schedule"],"type": "object"},@@ -28449,6 +32406,10 @@},"ServerFeaturesDto": {"properties": {+ "backups": {+ "description": "Whether the backups feature is enabled",+ "type": "boolean"+ },"configFile": {"description": "Whether config file is available","type": "boolean"@@ -28515,6 +32476,7 @@}},"required": [+ "backups","configFile","duplicateDetection","email",@@ -28923,6 +32885,14 @@"restoreBackupFilename": {"description": "Restore backup filename","type": "string"+ },+ "rollbackRepositoryId": {+ "description": "Rollback repository ID",+ "type": "string"+ },+ "rollbackSnapshotId": {+ "description": "Rollback snapshot ID",+ "type": "string"}},"required": [@@ -29891,6 +33861,80 @@},"type": "object"},+ "SnapshotDto": {+ "properties": {+ "id": {+ "type": "string"+ },+ "paths": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "summary": {+ "$ref": "#/components/schemas/SnapshotSummaryDto"+ },+ "tags": {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ "time": {+ "type": "string"+ }+ },+ "required": [+ "id",+ "paths",+ "time"+ ],+ "type": "object"+ },+ "SnapshotSummaryDto": {+ "properties": {+ "dataAdded": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "filesChanged": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "filesNew": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "filesUnmodified": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "totalBytes": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ },+ "totalFiles": {+ "maximum": 9007199254740991,+ "minimum": -9007199254740991,+ "type": "integer"+ }+ },+ "required": [+ "dataAdded",+ "filesChanged",+ "filesNew",+ "filesUnmodified",+ "totalBytes",+ "totalFiles"+ ],+ "type": "object"+ },"SourceType": {"description": "Face detection source type","enum": [@@ -30711,6 +34755,59 @@],"type": "object"},+ "SupportModeResponseDto": {+ "properties": {+ "includePaths": {+ "description": "Send file paths as-is instead of redacted placeholders",+ "type": "boolean"+ },+ "remainingRuns": {+ "description": "How many more backup, cleanup, restore and delete runs use verbose restic logging",+ "maximum": 20,+ "minimum": 0,+ "type": "integer"+ },+ "streamToFuto": {+ "description": "Stream those runs’ logs to FUTO; requires the support-log-streaming feature",+ "type": "boolean"+ },+ "streamingAvailable": {+ "description": "Whether this account may stream support logs to FUTO",+ "type": "boolean"+ }+ },+ "required": [+ "includePaths",+ "remainingRuns",+ "streamToFuto",+ "streamingAvailable"+ ],+ "type": "object"+ },+ "SupportModeUpdateRequestDto": {+ "properties": {+ "includePaths": {+ "description": "Send file paths as-is instead of redacted placeholders",+ "type": "boolean"+ },+ "remainingRuns": {+ "description": "How many more backup, cleanup, restore and delete runs use verbose restic logging",+ "maximum": 20,+ "minimum": 0,+ "type": "integer"+ },+ "streamToFuto": {+ "description": "Stream those runs’ logs to FUTO; requires the support-log-streaming feature",+ "type": "boolean"+ }+ },+ "required": [+ "includePaths",+ "remainingRuns",+ "streamToFuto"+ ],+ "type": "object"+ },"SyncAckDeleteDto": {"properties": {"types": {@@ -32950,6 +37047,13 @@},"type": "object"},+ "TelemetryLevel": {+ "enum": [+ "full",+ "none"+ ],+ "type": "string"+ },"TemplateDto": {"properties": {"template": {@@ -32991,6 +37095,43 @@],"type": "object"},+ "TicketAction": {+ "enum": [+ "repository.delete",+ "repository.disable-worm"+ ],+ "type": "string"+ },+ "TicketCreateRequestDto": {+ "properties": {+ "action": {+ "$ref": "#/components/schemas/TicketAction"+ },+ "repositoryId": {+ "description": "Repository the ticket is bound to",+ "format": "uuid",+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",+ "type": "string"+ }+ },+ "required": [+ "action",+ "repositoryId"+ ],+ "type": "object"+ },+ "TicketCreateResponseDto": {+ "properties": {+ "redirectTo": {+ "description": "Identity provider URL the browser must be sent to",+ "type": "string"+ }+ },+ "required": [+ "redirectTo"+ ],+ "type": "object"+ },"TimeBucketAssetResponseDto": {"properties": {"city": {@@ -34708,6 +38849,29 @@}},"type": "object"+ },+ "YuccaJobName": {+ "enum": [+ "repository-backup",+ "repository-prune",+ "repository-restore",+ "repository-restore-from-point",+ "repository-snapshot-forget",+ "repository-sync-metrics"+ ],+ "type": "string"+ },+ "YuccaJobStatus": {+ "enum": [+ "queued",+ "running",+ "complete",+ "warn",+ "failed",+ "cancelled",+ "incomplete"+ ],+ "type": "string"}}}diff --git a/packages/sdk/src/fetch-client.ts b/packages/sdk/src/fetch-client.tsindex ee0f0de0a9..92ec218adb 100644--- a/packages/sdk/src/fetch-client.ts+++ b/packages/sdk/src/fetch-client.ts@@ -63,6 +63,8 @@ export type AdminConfigDatabaseBackupDto = {keepLastAmount: number;};export type AdminConfigBackupsDto = {+ /** Whether the backups feature is enabled */+ beta?: boolean;database: AdminConfigDatabaseBackupDto;};export type AdminConfigFFmpegRealtimeDto = {@@ -478,6 +480,10 @@ export type SetMaintenanceModeDto = {action: MaintenanceAction;/** Restore backup filename */restoreBackupFilename?: string;+ /** Rollback repository ID */+ rollbackRepositoryId?: string;+ /** Rollback snapshot ID */+ rollbackSnapshotId?: string;};export type MaintenanceDetectInstallStorageFolderDto = {/** Number of files in the folder */@@ -503,6 +509,8 @@ export type MaintenanceStatusResponseDto = {action: MaintenanceAction;active: boolean;error?: string;+ /** FUTO Backups job ID */+ futoBackupsJobId?: string;progress?: number;task?: string;};@@ -1764,6 +1772,364 @@ export type FaceDto = {/** Face ID */id: string;};+export type DeviceFlowEventDto = {+ backendId?: string;+ reason?: DeviceFlowFailureReason;+ token?: string;+ "type": DeviceFlowEventType;+ userCode?: string;+ verificationUri?: string;+};+export type CreateSessionRequestDto = {+ token: string;+};+export type TicketCreateRequestDto = {+ action: TicketAction;+ /** Repository the ticket is bound to */+ repositoryId: string;+};+export type TicketCreateResponseDto = {+ /** Identity provider URL the browser must be sent to */+ redirectTo: string;+};+export type BackendDto = {+ description: string;+ error?: string;+ id: string;+ isOnline: boolean;+ "type": BackendType;+};+export type BackendsResponseDto = {+ backends: BackendDto[];+};+export type CreateLocalBackendRequestDto = {+ path: string;+};+export type BackendResponseDto = {+ backend: BackendDto;+};+export type BandwidthDto = {+ bytesPerSec: number;+ quietHours?: string;+};+export type ConfigResponseDto = {+ bandwidth: BandwidthDto;+};+export type ConfigUpdateRequestDto = {+ bandwidth: BandwidthDto;+};+export type FilesystemListingItemDto = {+ isDirectory: boolean;+ path: string;+};+export type FilesystemListingResponseDto = {+ items: FilesystemListingItemDto[];+ parent: string;+ path: string;+};+export type ImmichIntegrationConfigurationDto = {+ backupConfiguration: boolean;+ dataFolders: string[];+ /** IDs of the external libraries to back up. Use ["all"] to back up every library, including ones added later. */+ libraries: string[];+};+export type ImmichIntegrationDto = {+ configuration: ImmichIntegrationConfigurationDto;+ id: string;+ scheduleId: string;+};+export type ImmichLibraryDto = {+ exclusionPatterns: string[];+ id: string;+ importPaths: string[];+ name: string;+};+export type ImmichStateDto = {+ dataFolders: string[];+ dataPath: string;+ libraries: ImmichLibraryDto[];+};+export type IntegrationsResponseDto = {+ immichIntegration?: ImmichIntegrationDto;+ immichState?: ImmichStateDto;+};+export type RetentionPolicyDto = {+ keepLast?: number;+ keepWithin?: string;+ keepWithinDaily?: string;+ keepWithinHourly?: string;+ keepWithinMonthly?: string;+ keepWithinWeekly?: string;+ keepWithinYearly?: string;+};+export type ConfigureImmichIntegrationRequestDto = {+ backupConfiguration: boolean;+ cron: string;+ dataFolders: string[];+ /** IDs of the external libraries to back up. Use ["all"] to back up every library, including ones added later. */+ libraries: string[];+ name: string;+ paused?: boolean;+ repositoryId?: string;+ retentionPolicy?: (RetentionPolicyDto) | null;+ worm: boolean;+};+export type ConfigureImmichIntegrationResponseDto = {+ repositoryId: string;+};+export type ConfigureImmichDatabaseDumpRequestDto = {+ enabled?: boolean;+ keepLastAmount?: number;+};+export type ImmichRollbackRequestDto = {+ backupFileName?: string;+ repositoryId: string;+ snapshotId: string;+};+export type ImmichDatabaseDumpConfigDto = {+ enabled: boolean;+ keepLastAmount: number;+};+export type JobSummaryDto = {+ "type": Type;+ filesNew: number;+ filesChanged: number;+ totalFilesProcessed: number;+ totalBytesProcessed: number;+ snapshotId?: string;+} | {+ "type": Type2;+ filesRestored: number;+ filesSkipped: number;+ bytesRestored: number;+} | {+ "type": Type3;+ kept: number;+ removed: number;+};+export type JobSupportDto = {+ /** Log lines that could not be streamed in time */+ droppedLines: number;+ /** Log lines that could not be written to the local support log */+ localDroppedLines: number;+ /** Support code to share with FUTO when the logs were streamed */+ sessionId?: string;+};+export type JobOutcomeDto = {+ errors: string[];+ summary?: JobSummaryDto;+ support?: JobSupportDto;+};+export type JobProgressDto = {+ bytesDone?: number;+ currentFiles: string[];+ estimatedEndAt?: string;+ percentDone: number;+ scanning: boolean;+ totalBytes?: number;+};+export type JobDto = {+ end?: string;+ id: string;+ name: YuccaJobName;+ outcome?: JobOutcomeDto;+ progress?: JobProgressDto;+ queuedAt: string;+ repositoryId: string;+ start?: string;+ status: YuccaJobStatus;+};+export type RepositoryBackendDto = {+ id: string;+ online: boolean;+ "type": BackendType;+};+export type RepositoryBackendsDto = {+ primary: RepositoryBackendDto;+ secondary: RepositoryBackendDto[];+};+export type RepositoryConfigurationDto = {+ paths: string[];+ retentionPolicy?: (RetentionPolicyDto) | null;+};+export type RepositoryMeterDto = {+ lastUpdated?: string | null;+ objectCount: number;+ sizeBytes: number;+};+export type RepositoryMetricsDto = {+ lastBackup?: string | null;+ lastBackupDuration?: number | null;+ lastBackupStatus?: (BackupStatus) | null;+ lastStarted?: string | null;+ sizeBytes: number;+};+export type LocalRepositoryDto = {+ backends?: RepositoryBackendsDto;+ configuration?: RepositoryConfigurationDto;+ id: string;+ meter?: RepositoryMeterDto;+ metrics: RepositoryMetricsDto;+ name: string;+ siteCode: string | null;+ storageClusterCode: string | null;+ worm: boolean;+};+export type ScheduleDto = {+ cron: string;+ id: string;+ lastFinished?: string;+ lastRun?: string;+ name: string;+ paused: boolean;+ repositories: string[];+};+export type ImmichBackupStatusDto = {+ backend?: BackendDto;+ databaseDump?: ImmichDatabaseDumpConfigDto;+ databaseDumpWarningIgnored?: boolean;+ integration?: ImmichIntegrationDto;+ latestBackupJob?: JobDto;+ repository?: LocalRepositoryDto;+ schedule?: ScheduleDto;+};+export type JobListResponseDto = {+ jobs: JobDto[];+};+export type OnboardingStatusResponseDto = {+ error?: string;+ hasBackend: boolean;+ hasBackup: boolean;+ hasOnboardedKey: boolean;+ hasSchedule: boolean;+ hasSkippedExtraConfig: boolean;+ hasTelemetry: TelemetryLevel;+ isAuthenticated: boolean;+ requiresAuthentication: boolean;+ status: BootstrapStatus;+};+export type CurrentRecoveryKeyResponse = {+ recoveryKey: string;+};+export type ImportRecoveryKeyRequest = {+ recoveryKey: string;+};+export type RepositoryListResponseDto = {+ repositories: LocalRepositoryDto[];+};+export type RepositoryCreateRequestDto = {+ name: string;+ paths?: string[];+ retentionPolicy?: (RetentionPolicyDto) | null;+ /** Internal site code from environment metadata */+ site?: string;+ worm: boolean;+};+export type RepositoryCreateResponseDto = {+ repository: LocalRepositoryDto;+};+export type SnapshotSummaryDto = {+ dataAdded: number;+ filesChanged: number;+ filesNew: number;+ filesUnmodified: number;+ totalBytes: number;+ totalFiles: number;+};+export type SnapshotDto = {+ id: string;+ paths: string[];+ summary?: SnapshotSummaryDto;+ tags?: string[];+ time: string;+};+export type InspectedLocalRepositoryDto = {+ backends?: RepositoryBackendsDto;+ configuration?: RepositoryConfigurationDto;+ id: string;+ meter?: RepositoryMeterDto;+ metrics: RepositoryMetricsDto;+ name: string;+ siteCode: string | null;+ snapshots?: SnapshotDto[];+ storageClusterCode: string | null;+ worm: boolean;+};+export type RepositoryInspectResponseDto = {+ repositories: InspectedLocalRepositoryDto[];+};+export type RepositoryUpdateRequestDto = {+ name?: string;+ paths?: string[];+ retentionPolicy?: (RetentionPolicyDto) | null;+ worm?: boolean;+};+export type RepositoryUpdateResponseDto = {+ repository: LocalRepositoryDto;+};+export type JobResponseDto = {+ jobId: string;+};+export type RepositoryPrimaryBackendReconfigureRequestDto = {+ backendId: string;+};+export type RepositoryCheckImportResponseDto = {+ readable: boolean;+};+export type ListSnapshotsResponseDto = {+ snapshots: SnapshotDto[];+};+export type RepositorySnapshotRestoreRequestDto = {+ include?: string[];+ target?: string;+};+export type RepositorySnapshotRestoreFromPointRequestDto = {+ include?: string[];+ yuccaConfig?: string;+};+export type RepositorySyncDeletionResponseDto = {+ /** Whether the repository was deleted remotely and removed from this server */+ deleted: boolean;+};+export type ScheduleListResponseDto = {+ schedules: ScheduleDto[];+};+export type ScheduleCreateRequestDto = {+ cron: string;+ name: string;+ paused?: boolean;+ repositories: string[];+};+export type ScheduleCreateResponseDto = {+ schedule: ScheduleDto;+};+export type ScheduleUpdateRequestDto = {+ cron?: string;+ name?: string;+ paused?: boolean;+ repositories?: string[];+};+export type ScheduleUpdateResponseDto = {+ schedule: ScheduleDto;+};+export type SupportModeResponseDto = {+ /** Send file paths as-is instead of redacted placeholders */+ includePaths: boolean;+ /** How many more backup, cleanup, restore and delete runs use verbose restic logging */+ remainingRuns: number;+ /** Stream those runs’ logs to FUTO; requires the support-log-streaming feature */+ streamToFuto: boolean;+ /** Whether this account may stream support logs to FUTO */+ streamingAvailable: boolean;+};+export type SupportModeUpdateRequestDto = {+ /** Send file paths as-is instead of redacted placeholders */+ includePaths: boolean;+ /** How many more backup, cleanup, restore and delete runs use verbose restic logging */+ remainingRuns: number;+ /** Stream those runs’ logs to FUTO; requires the support-log-streaming feature */+ streamToFuto: boolean;+};export type QueueStatisticsDto = {/** Number of active jobs */active: number;@@ -2885,6 +3251,8 @@ export type ServerConfigDto = {userDeleteDelay: number;};export type ServerFeaturesDto = {+ /** Whether the backups feature is enabled */+ backups: boolean;/** Whether config file is available */configFile: boolean;/** Whether duplicate detection is enabled */@@ -5617,6 +5985,662 @@ export function reassignFacesById({ id, faceDto }: {body: faceDto})));}+/**+ * Connect a FUTO Backups account+ */+export function futoBackupsConnectDeviceFlow(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: DeviceFlowEventDto;+ }>("/futo-backups/auth/oidc/device", {+ ...opts+ }));+}+/**+ * Create session+ */+export function futoBackupsCreateSession({ createSessionRequestDto }: {+ createSessionRequestDto: CreateSessionRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/auth/session", oazapfts.json({+ ...opts,+ method: "POST",+ body: createSessionRequestDto+ })));+}+/**+ * Sign in with FUTO Backups account+ */+export function futoBackupsSessionDeviceFlow(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: DeviceFlowEventDto;+ }>("/futo-backups/auth/session/device", {+ ...opts+ }));+}+/**+ * Create a ticket+ */+export function futoBackupsCreateTicket({ ticketCreateRequestDto }: {+ ticketCreateRequestDto: TicketCreateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: TicketCreateResponseDto;+ }>("/futo-backups/auth/ticket", oazapfts.json({+ ...opts,+ method: "POST",+ body: ticketCreateRequestDto+ })));+}+/**+ * List backends+ */+export function futoBackupsGetBackends(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: BackendsResponseDto;+ }>("/futo-backups/backend", {+ ...opts+ }));+}+/**+ * Create a local backend+ */+export function futoBackupsCreateLocalBackend({ createLocalBackendRequestDto }: {+ createLocalBackendRequestDto: CreateLocalBackendRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: BackendResponseDto;+ }>("/futo-backups/backend/local", oazapfts.json({+ ...opts,+ method: "POST",+ body: createLocalBackendRequestDto+ })));+}+/**+ * Get backups orchestrator configuration+ */+export function futoBackupsGetConfig(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ConfigResponseDto;+ }>("/futo-backups/config", {+ ...opts+ }));+}+/**+ * Update backups orchestrator configuration+ */+export function futoBackupsUpdateConfig({ configUpdateRequestDto }: {+ configUpdateRequestDto: ConfigUpdateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ConfigResponseDto;+ }>("/futo-backups/config", oazapfts.json({+ ...opts,+ method: "PUT",+ body: configUpdateRequestDto+ })));+}+/**+ * Reset the backups orchestrator+ */+export function futoBackupsResetOrchestrator(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/debug/reset", {+ ...opts,+ method: "POST"+ }));+}+/**+ * List files+ */+export function futoBackupsGetFileListing({ path }: {+ path?: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: FilesystemListingResponseDto;+ }>(`/futo-backups/fs${QS.query(QS.explode({+ path+ }))}`, {+ ...opts+ }));+}+/**+ * Get backup integrations+ */+export function futoBackupsGetIntegrations(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: IntegrationsResponseDto;+ }>("/futo-backups/integrations", {+ ...opts+ }));+}+/**+ * Configure the Immich backup integration+ */+export function futoBackupsConfigureImmichIntegration({ configureImmichIntegrationRequestDto }: {+ configureImmichIntegrationRequestDto: ConfigureImmichIntegrationRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: ConfigureImmichIntegrationResponseDto;+ }>("/futo-backups/integrations/immich", oazapfts.json({+ ...opts,+ method: "POST",+ body: configureImmichIntegrationRequestDto+ })));+}+/**+ * Configure Immich database dumps+ */+export function futoBackupsConfigureImmichDatabaseDump({ configureImmichDatabaseDumpRequestDto }: {+ configureImmichDatabaseDumpRequestDto: ConfigureImmichDatabaseDumpRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/integrations/immich/database-dump", oazapfts.json({+ ...opts,+ method: "POST",+ body: configureImmichDatabaseDumpRequestDto+ })));+}+/**+ * Ignore the Immich database dump warning+ */+export function futoBackupsIgnoreImmichDatabaseDumpWarning(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/integrations/immich/database-dump/ignore-warning", {+ ...opts,+ method: "POST"+ }));+}+/**+ * Roll Immich back to a snapshot+ */+export function futoBackupsStartImmichRollback({ immichRollbackRequestDto }: {+ immichRollbackRequestDto: ImmichRollbackRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/integrations/immich/rollback", oazapfts.json({+ ...opts,+ method: "POST",+ body: immichRollbackRequestDto+ })));+}+/**+ * Get Immich backup status+ */+export function futoBackupsGetImmichBackupStatus(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ImmichBackupStatusDto;+ }>("/futo-backups/integrations/immich/status", {+ ...opts+ }));+}+/**+ * List jobs+ */+export function futoBackupsGetJobs({ repositoryId }: {+ repositoryId: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: JobListResponseDto;+ }>(`/futo-backups/jobs${QS.query(QS.explode({+ repositoryId+ }))}`, {+ ...opts+ }));+}+/**+ * Cancel a job+ */+export function futoBackupsCancelJob({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText(`/futo-backups/jobs/${encodeURIComponent(id)}`, {+ ...opts,+ method: "DELETE"+ }));+}+/**+ * Get a job+ */+export function futoBackupsGetJob({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: JobDto;+ }>(`/futo-backups/jobs/${encodeURIComponent(id)}`, {+ ...opts+ }));+}+/**+ * Download a job log+ */+export function futoBackupsDownloadJobLog({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchBlob<{+ status: 200;+ data: Blob;+ }>(`/futo-backups/jobs/${encodeURIComponent(id)}/download`, {+ ...opts+ }));+}+/**+ * Download a job support log+ */+export function futoBackupsDownloadJobSupportLog({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchBlob<{+ status: 200;+ data: Blob;+ }>(`/futo-backups/jobs/${encodeURIComponent(id)}/support-log/download`, {+ ...opts+ }));+}+/**+ * Get backup onboarding status+ */+export function futoBackupsOnboardingStatus(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: OnboardingStatusResponseDto;+ }>("/futo-backups/onboarding", {+ ...opts+ }));+}+/**+ * Get the backup recovery key+ */+export function futoBackupsCurrentRecoveryKey(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: CurrentRecoveryKeyResponse;+ }>("/futo-backups/onboarding/recovery-key", {+ ...opts+ }));+}+/**+ * Confirm the backup recovery key+ */+export function futoBackupsConfirmRecoveryKey(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/onboarding/recovery-key", {+ ...opts,+ method: "POST"+ }));+}+/**+ * Import a backup recovery key+ */+export function futoBackupsImportRecoveryKey({ importRecoveryKeyRequest }: {+ importRecoveryKeyRequest: ImportRecoveryKeyRequest;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/onboarding/recovery-key", oazapfts.json({+ ...opts,+ method: "PUT",+ body: importRecoveryKeyRequest+ })));+}+/**+ * Report a startup error+ */+export function futoBackupsReportError(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/onboarding/report-error", {+ ...opts,+ method: "POST"+ }));+}+/**+ * Skip optional backup onboarding+ */+export function futoBackupsSkipOnboardingExtraConfig(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/onboarding/skip", {+ ...opts,+ method: "POST"+ }));+}+/**+ * Enable FUTO Backups telemetry+ */+export function futoBackupsEnableTelemetry(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText("/futo-backups/onboarding/telemetry", {+ ...opts,+ method: "POST"+ }));+}+/**+ * List backups+ */+export function futoBackupsGetRepositories(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: RepositoryListResponseDto;+ }>("/futo-backups/repository", {+ ...opts+ }));+}+/**+ * Create a new backup+ */+export function futoBackupsCreateRepository({ backend, repositoryCreateRequestDto }: {+ backend?: string;+ repositoryCreateRequestDto: RepositoryCreateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: RepositoryCreateResponseDto;+ }>(`/futo-backups/repository${QS.query(QS.explode({+ backend+ }))}`, oazapfts.json({+ ...opts,+ method: "POST",+ body: repositoryCreateRequestDto+ })));+}+/**+ * List remote backups+ */+export function futoBackupsInspectRepositories({ backend }: {+ backend?: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: RepositoryInspectResponseDto;+ }>(`/futo-backups/repository/inspect${QS.query(QS.explode({+ backend+ }))}`, {+ ...opts+ }));+}+/**+ * Remove a backup+ */+export function futoBackupsDeleteRepository({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText(`/futo-backups/repository/${encodeURIComponent(id)}`, {+ ...opts,+ method: "DELETE"+ }));+}+/**+ * Update a backup+ */+export function futoBackupsUpdateRepository({ backend, id, repositoryUpdateRequestDto }: {+ backend?: string;+ id: string;+ repositoryUpdateRequestDto: RepositoryUpdateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: RepositoryUpdateResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}${QS.query(QS.explode({+ backend+ }))}`, oazapfts.json({+ ...opts,+ method: "PATCH",+ body: repositoryUpdateRequestDto+ })));+}+/**+ * Start a backup+ */+export function futoBackupsCreateBackup({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: JobResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}`, {+ ...opts,+ method: "POST"+ }));+}+/**+ * Change the primary backend+ */+export function futoBackupsReconfigureRepositoryPrimaryBackend({ id, repositoryPrimaryBackendReconfigureRequestDto }: {+ id: string;+ repositoryPrimaryBackendReconfigureRequestDto: RepositoryPrimaryBackendReconfigureRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: RepositoryCreateResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/backend`, oazapfts.json({+ ...opts,+ method: "PUT",+ body: repositoryPrimaryBackendReconfigureRequestDto+ })));+}+/**+ * Check a repository import+ */+export function futoBackupsCheckImportRepository({ backend, id }: {+ backend: string;+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: RepositoryCheckImportResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/import${QS.query(QS.explode({+ backend+ }))}`, {+ ...opts+ }));+}+/**+ * Import a repository+ */+export function futoBackupsImportRepository({ backend, id }: {+ backend: string;+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: RepositoryCreateResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/import${QS.query(QS.explode({+ backend+ }))}`, {+ ...opts,+ method: "POST"+ }));+}+/**+ * List snapshots+ */+export function futoBackupsGetSnapshots({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ListSnapshotsResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/snapshots`, {+ ...opts+ }));+}+/**+ * Prune a repository+ */+export function futoBackupsPruneRepository({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: JobResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/snapshots/prune`, {+ ...opts,+ method: "POST"+ }));+}+/**+ * Delete a snapshot+ */+export function futoBackupsForgetSnapshot({ id, snapshot }: {+ id: string;+ snapshot: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ListSnapshotsResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}`, {+ ...opts,+ method: "DELETE"+ }));+}+/**+ * Restore a snapshot+ */+export function futoBackupsRestoreSnapshot({ id, snapshot, repositorySnapshotRestoreRequestDto }: {+ id: string;+ snapshot: string;+ repositorySnapshotRestoreRequestDto: RepositorySnapshotRestoreRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: JobResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}`, oazapfts.json({+ ...opts,+ method: "POST",+ body: repositorySnapshotRestoreRequestDto+ })));+}+/**+ * List snapshot files+ */+export function futoBackupsGetSnapshotListing({ id, path, snapshot }: {+ id: string;+ path?: string;+ snapshot: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: FilesystemListingResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}/listing${QS.query(QS.explode({+ path+ }))}`, {+ ...opts+ }));+}+/**+ * Restore from snapshot+ */+export function futoBackupsRestoreFromPoint({ backend, id, snapshot, repositorySnapshotRestoreFromPointRequestDto }: {+ backend: string;+ id: string;+ snapshot: string;+ repositorySnapshotRestoreFromPointRequestDto: RepositorySnapshotRestoreFromPointRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: JobResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}/restore-from-point${QS.query(QS.explode({+ backend+ }))}`, oazapfts.json({+ ...opts,+ method: "POST",+ body: repositorySnapshotRestoreFromPointRequestDto+ })));+}+/**+ * Sync a remote deletion+ */+export function futoBackupsSyncRepositoryDeletion({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: RepositorySyncDeletionResponseDto;+ }>(`/futo-backups/repository/${encodeURIComponent(id)}/sync-deletion`, {+ ...opts,+ method: "POST"+ }));+}+/**+ * List schedules+ */+export function futoBackupsGetSchedules(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ScheduleListResponseDto;+ }>("/futo-backups/schedule", {+ ...opts+ }));+}+/**+ * Create a schedule+ */+export function futoBackupsCreateSchedule({ scheduleCreateRequestDto }: {+ scheduleCreateRequestDto: ScheduleCreateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 201;+ data: ScheduleCreateResponseDto;+ }>("/futo-backups/schedule", oazapfts.json({+ ...opts,+ method: "POST",+ body: scheduleCreateRequestDto+ })));+}+/**+ * Delete a schedule+ */+export function futoBackupsRemoveSchedule({ id }: {+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText(`/futo-backups/schedule/${encodeURIComponent(id)}`, {+ ...opts,+ method: "DELETE"+ }));+}+/**+ * Update a schedule+ */+export function futoBackupsUpdateSchedule({ id, scheduleUpdateRequestDto }: {+ id: string;+ scheduleUpdateRequestDto: ScheduleUpdateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: ScheduleUpdateResponseDto;+ }>(`/futo-backups/schedule/${encodeURIComponent(id)}`, oazapfts.json({+ ...opts,+ method: "PATCH",+ body: scheduleUpdateRequestDto+ })));+}+/**+ * Get support mode+ */+export function futoBackupsGetSupportMode(opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: SupportModeResponseDto;+ }>("/futo-backups/support-mode", {+ ...opts+ }));+}+/**+ * Update support mode+ */+export function futoBackupsUpdateSupportMode({ supportModeUpdateRequestDto }: {+ supportModeUpdateRequestDto: SupportModeUpdateRequestDto;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchJson<{+ status: 200;+ data: SupportModeResponseDto;+ }>("/futo-backups/support-mode", oazapfts.json({+ ...opts,+ method: "PUT",+ body: supportModeUpdateRequestDto+ })));+}/*** Retrieve queue counts and status*/@@ -8242,7 +9266,8 @@ export enum MaintenanceAction {Start = "start",End = "end",SelectDatabaseRestore = "select_database_restore",- RestoreDatabase = "restore_database"+ RestoreDatabase = "restore_database",+ Rollback = "rollback"}export enum StorageFolder {EncodedVideo = "encoded-video",@@ -8532,6 +9557,68 @@ export enum SourceType {Exif = "exif",Manual = "manual"}+export enum DeviceFlowFailureReason {+ NotConnected = "NOT_CONNECTED",+ DeviceFlowFailed = "DEVICE_FLOW_FAILED",+ WrongAccount = "WRONG_ACCOUNT",+ Unknown = "UNKNOWN"+}+export enum DeviceFlowEventType {+ Start = "START",+ Success = "SUCCESS",+ Failure = "FAILURE"+}+export enum TicketAction {+ RepositoryDelete = "repository.delete",+ RepositoryDisableWorm = "repository.disable-worm"+}+export enum BackendType {+ Yucca = "yucca",+ Local = "local",+ S3 = "s3"+}+export enum YuccaJobName {+ RepositoryBackup = "repository-backup",+ RepositoryPrune = "repository-prune",+ RepositoryRestore = "repository-restore",+ RepositoryRestoreFromPoint = "repository-restore-from-point",+ RepositorySnapshotForget = "repository-snapshot-forget",+ RepositorySyncMetrics = "repository-sync-metrics"+}+export enum Type {+ Backup = "backup"+}+export enum Type2 {+ Restore = "restore"+}+export enum Type3 {+ Prune = "prune"+}+export enum YuccaJobStatus {+ Queued = "queued",+ Running = "running",+ Complete = "complete",+ Warn = "warn",+ Failed = "failed",+ Cancelled = "cancelled",+ Incomplete = "incomplete"+}+export enum BackupStatus {+ Incomplete = "incomplete",+ Complete = "complete",+ Warn = "warn",+ Failed = "failed",+ Cancelled = "cancelled"+}+export enum TelemetryLevel {+ Full = "full",+ None = "none"+}+export enum BootstrapStatus {+ NotReady = "not-ready",+ Ready = "ready",+ Error = "error"+}export enum ManualJobName {PersonCleanup = "person-cleanup",TagCleanup = "tag-cleanup",diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 10cfe010a6..c6a61367e7 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -565,6 +565,9 @@ importers:'@extism/extism':specifier: 2.0.0-rc13version: 2.0.0-rc13+ '@futo-org/backups-orchestrator-api':+ specifier: 1.11.5+ version: 1.11.5(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])(@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected]))(@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@typescript/[email protected])([email protected]))(@nestjs/[email protected])([email protected])([email protected])'@immich/plugin-sdk':specifier: workspace:*version: link:../packages/plugin-sdk@@ -953,6 +956,9 @@ importers:'@formatjs/icu-messageformat-parser':specifier: ^3.0.0version: 3.5.22+ '@futo-org/backups-orchestrator-ui':+ specifier: 1.11.5+ version: 1.11.5(@immich/[email protected](@sveltejs/[email protected](@opentelemetry/[email protected])(@sveltejs/[email protected]([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))(@typescript/[email protected])([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected](@typescript-eslint/[email protected]))([email protected]))(@lingui/[email protected]([email protected])([email protected])([email protected]))(@typescript/[email protected])([email protected])([email protected](@typescript-eslint/[email protected]))'@immich/justified-layout-wasm':specifier: ^0.4.3version: 0.4.5@@ -2918,6 +2924,29 @@ packages:resolution: {integrity: sha512-v0BLa0eqg7ubvVWeNSHVBs8fWH/GJicERZoJaxJ3FE/lj67VSqzoMg9pzfZVOfLMX10y0pGwQAuxoRVVH2patg==}engines: {node: '>=6'}+ '@futo-org/[email protected]':+ resolution: {integrity: sha512-P+fVSFa+XAvVkYPrpgsFCqkSI8n8x0rm6qMJJa3DMKzmSL/8iZVjVjKd5rYl6eLi1UBrYzN9jSEPNnDtur6YDA==}++ '@futo-org/[email protected]':+ resolution: {integrity: sha512-YcIdWrgoyYx8L1vu2Gwtb+k1lQL32xQOK65JAAYMdZ7uEb+B/uEwHQOJWgCoxH6exwvEVtWPbvj3Mkn84r5pTQ==}+ peerDependencies:+ '@nestjs/common': ^12.0.0+ '@nestjs/core': ^12.0.0+ '@nestjs/platform-socket.io': ^12.0.0+ '@nestjs/schedule': ^12.0.0+ '@nestjs/swagger': ^12.0.0+ '@nestjs/websockets': ^12.0.0++ '@futo-org/[email protected]':+ resolution: {integrity: sha512-sfUfsJCeR7HEfmbLu/eAACAtY27ALxLPlZ9BYW9MnnQ9BXQHGBnM+hZ0pGs/YwtYuNsAeoq5kEbIadVN5sX6Gw==}+ peerDependencies:+ '@immich/ui': ^0.90.0+ svelte: ^5.0.0++ '@futo-org/[email protected]':+ resolution: {integrity: sha512-z27pVTOZA7h755RcZi7MCcCNh6o9lqmk55lRsAxV2gVWBQWfuPpdWVrpRI5Or3IgbYR4B82t7ICHBgtgcWvYrg==}+ engines: {node: '>=20'}+'@golevelup/[email protected]':resolution: {integrity: sha512-wBlSxU1wgBS+x4adwgp2qklXKCC9sufn8zrrSJ1WSCEHb48OBMrn0FskU862CFPwyotJaElRrirHTICAOsl1Mg==}peerDependencies:@@ -3515,6 +3544,133 @@ packages:'@lezer/[email protected]':resolution: {integrity: sha512-rnCpTIBafOx4mRp43xOxDJbFipJm/c0cia/V5TiGlhmMa+wsSdoGmUN3w5Bqrks/09Q/D4tNAmWaT8p6NRi77A==}+ '@lingui/[email protected]':+ resolution: {integrity: sha512-geg2chO+ahysUT7RdPdOMHNVb2hpM7jDrQpro+IyZKG6NwZ6BlsroxXpJKC27k/Jw1g7uvMBrkw7zOPeGCfi5A==}+ engines: {node: '>=22.19.0'}++ '@lingui/[email protected]':+ resolution: {integrity: sha512-AQs7UsweJS+JMb1ySzETHFktdgwmdQaJM7B9WWVvuhJv0BtiI/S/XJcl2Nyh93mvWD3HArIFRWECKnZ0y5lIeQ==}+ engines: {node: '>=22.19.0'}+ peerDependencies:+ '@babel/core': ^7.20.12 || ^8.0.0+ peerDependenciesMeta:+ '@babel/core':+ optional: true++ '@lingui/[email protected]':+ resolution: {integrity: sha512-C80aWjnGutoPFkw7F995yt3APK32+7X5d36DdyL5MKSrAHf8irBOG2wjy2nhm6gjDWOS0+s6zCTh8HX2HDC+CQ==}+ engines: {node: '>=22.19.0'}+ hasBin: true+ peerDependencies:+ esbuild: ^0.28.1+ rolldown: ^1.0.0+ peerDependenciesMeta:+ esbuild:+ optional: true+ rolldown:+ optional: true++ '@lingui/[email protected]':+ resolution: {integrity: sha512-utgrZY0AUj08dLi/9jSrR0chwBlvPKjGGDCPHR1UHCVZb/EIxskbITiCVITUfVuxp5+FMSPMm0V1lzF1Q86qlg==}+ engines: {node: '>=22.19.0'}++ '@lingui/[email protected]':+ resolution: {integrity: sha512-Y+iZq9NqnqZOqHNgPomUFP21KH/zs4oTTizWoz0AKAkBbq9T9yb1DSz/ugtBRjF1YLtKMF9tq28v3thMHANSiQ==}+ engines: {node: '>=20.0.0'}+ peerDependencies:+ '@lingui/babel-plugin-lingui-macro': 5.9.5+ babel-plugin-macros: 2 || 3+ peerDependenciesMeta:+ '@lingui/babel-plugin-lingui-macro':+ optional: true+ babel-plugin-macros:+ optional: true++ '@lingui/[email protected]':+ resolution: {integrity: sha512-s2b2yyXBwNFdKz5r3S9zaGLlJpSTH3+k+q0RGQr/TbjoTDsuTCMbHHT6stTWj377/4p/E3UTOrIy7r7J5jTGUA==}+ engines: {node: '>=22.19.0'}+ peerDependencies:+ babel-plugin-macros: 2 || 3+ peerDependenciesMeta:+ babel-plugin-macros:+ optional: true++ '@lingui/[email protected]':+ resolution: {integrity: sha512-C+PjhCV4ERBCTFFymcIpBNfZaQfMcwh97+YENvmqgaUNQ95WcMVV9dk+qV+V+QG4g82a6ZCNbce1zSAxoy7rdw==}+ engines: {node: '>=22.19.0'}++ '@lingui/[email protected]':+ resolution: {integrity: sha512-t3dNbjb1dWkvcpXGMXIEyBDO3l4B8J2ColZXi0NTG1ioAj+sDfFxFB8fepVgd3JAk+AwARlOLvF14oS0mAdgpw==}+ engines: {node: '>=20.0.0'}++ '@lingui/[email protected]':+ resolution: {integrity: sha512-IzCtKG+wtC0uMFs7pONVAFscHzQN0FjW6RG7DULVJcHaLmH/hOGc7QpGX7Jzm7d8QguDfUM0QmSwFwLkYDmNvQ==}+ engines: {node: '>=22.19.0'}++ '@lingui/[email protected]':+ resolution: {integrity: sha512-kAwVqJlKv868dGJOhqXXqHwhI3bOlvdHSZz8rozlEEidvBuw6Srr0Es5hwisLlwybzcTYstjOeVGxmvu3QAV4g==}+ engines: {node: '>=22.19.0'}+ cpu: [arm64]+ os: [android]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-0KEoSob+pYS1jyRB+2bJp78L2L2i/VODFIk5Gs8LmKV58xZ+uN8MOhf1dYBBsi6+0tiqPartSCk3WA4i+lKPUQ==}+ engines: {node: '>=22.19.0'}+ cpu: [arm64]+ os: [darwin]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-e7liIjkzbJ8w3F9PHzZPmpYpeiv7XO4Np9J1tEpUamKYEdYBNt4AKr/UmWAQ7AjxbZSV9N8lj1ulUl3pdFUuaQ==}+ engines: {node: '>=22.19.0'}+ cpu: [x64]+ os: [darwin]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-JKu/8CvLsYUiRbRSnuzmrQk24tfuizgnDYlMxE5/awUUrRE+GlpaMP76PhJpkl+tV0v7t6zVe3+I5lbq7LaqVw==}+ engines: {node: '>=22.19.0'}+ cpu: [arm64]+ os: [linux]+ libc: [glibc]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-Aeexf/Ta0nZDZz3cDMAZ95GmFZ2lOxMwf1FK/ShK+U4WcNVSn3aI2KeuOeaLUfot9ZT8AiIIELPV4gO6b/GJgg==}+ engines: {node: '>=22.19.0'}+ cpu: [arm64]+ os: [linux]+ libc: [musl]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-SwX1dLcQE9pVcXwIxSGTE2+zBmaO6NbjD9XPqCiyoO8RFTkUTLjdnRDGHxFlFpIGMlVArQz5mMQ6coyUFl+AiA==}+ engines: {node: '>=22.19.0'}+ cpu: [x64]+ os: [linux]+ libc: [glibc]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-aWI8e10I6i7K9BG77LJDHREozx/VT8j8onf0wxd43ACor2S1VwS0ZNlIfpNWQTWovmU/CUliGO/VWQq2jGa+Sg==}+ engines: {node: '>=22.19.0'}+ cpu: [x64]+ os: [linux]+ libc: [musl]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-M2TZP4gKgLaLbiboXIrY5+8GsaQLHvZ8E6cUFgAuSaBa8AMa73+pZO1eay/St9t8yDh6EL6hOlqN0HedUHMwyQ==}+ engines: {node: '>=22.19.0'}+ cpu: [arm64]+ os: [win32]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-5KvuSTFtDB8UGHS3Rxd+juYZgc51isQSx0hPukDObre6UxZGuUVCBmJ9YwoGVzXedViiNGmsQvrnCTBbVqI75g==}+ engines: {node: '>=22.19.0'}+ cpu: [x64]+ os: [win32]++ '@lingui/[email protected]':+ resolution: {integrity: sha512-xsn2R9YvWL9WuemM0ivSlXy14ORlfvPYLxFP3kbcFU3Pg5T9aRnmYOTfwszwGnjt4QsORO1mHHZT6k/Wr7V9pA==}+ engines: {node: '>=22.19.0'}+ peerDependencies:+ '@lingui/conf': ^6.0.1+'@lukeed/[email protected]':resolution: {integrity: sha512-Z7C/xXCiGWsg0KuKsHTKJxbWhpI3Vs5GwLfOean7MGyVFGqdRgBbAjOCh6u4bbjPc/8MJ2pZmK/0DLdCbivLDA==}engines: {node: '>=8'}@@ -3555,6 +3711,9 @@ packages:'@marijn/[email protected]':resolution: {integrity: sha512-FY+MKLBoTsLNJF/eLWaOsXGdz6uh3Iu1axjPf6TUq92IYumcTcXWHoS747JARLkcdlJ/Waiaxc5wQfFO8jC6NA==}+ '@material-symbols/[email protected]':+ resolution: {integrity: sha512-JJXRvRoHhMbrSFQIkiUwjFkCnurH0Yg+cGMCn9xS0PRtLXovIAQCz7NltNn/teQ9VRYmbzZB75Uw6Hx0umu5Bg==}+'@mdi/[email protected]':resolution: {integrity: sha512-KPnNOtm5i2pMabqZxpUz7iQf+mfrYZyKCZ8QNz85czgEt7cuHcGorWfdzUMWYA0SD+a6Hn4FmJ+YhzzzjkTZrQ==}@@ -3582,6 +3741,12 @@ packages:'@mermaid-js/[email protected]':resolution: {integrity: sha512-oYPyv8A4As1yH5Bx+04iQEQxXuIQDe0GKCNSRgao6z8AM9jixXIfP0vsppRLvGf+nKIOb9/LdpWA4YuJiVvESA==}+ '@messageformat/[email protected]':+ resolution: {integrity: sha512-rmGAfB1tIPER+gh3p/RgA+PVeRE/gxuQ2w4snFWPF5xtb5mbWR7Cbw7wCOftcUypbD6HVoxrVdyyghPm3WzP5A==}++ '@messageformat/[email protected]':+ resolution: {integrity: sha512-sc3hNZ0JtC32GhL5nUgPbh2ilcwji4G+Vmj/vhMd8hZaH//NDOvkfwKK1mFnRWG5h2DpksN8xr/HB5/+vMg3iw==}+'@microsoft/[email protected]':resolution: {integrity: sha512-VHyYyyoH63jFoO3shpw9Zfijk5v/9p/VrClW35z0/q6ooK7sSmxpzOkS4iZPxs3vO4XtBW4H38HRAKkAMIK7DA==}@@ -3700,6 +3865,18 @@ packages:'@nestjs/websockets':optional: true+ '@nestjs/[email protected]':+ resolution: {integrity: sha512-7MbpgNcxUcDlqcYY/qgZm1H7MfK3uGcRsd8lEjj9ZYvI9qTl6kdkkykpxZ6YjBRH3wlZK5dFLAei8h5qpsHzOw==}+ engines: {node: '>=20.19.0'}+ peerDependencies:+ '@nestjs/common': ^11.0.0 || ^12.0.0+ '@nestjs/core': ^11.0.0 || ^12.0.0++ '@nestjs/[email protected]':+ resolution: {integrity: sha512-Gr/lpj1pu5Lfn8b+6WeZZzj4J+Ggm1d4ImgrYLhiWahpJHoc/hhfQ9h9AAVVQ9vM+VskPrlngMu0RZwBIRsx3g==}+ peerDependencies:+ '@nestjs/common': ^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0+'@nestjs/[email protected]':resolution: {integrity: sha512-aX7lxZcqXldtnSr0bgT2ZPQvpTpIwBMW1GMX29o4s3q02vmq6JoTYuPW0GwYXa8BiFMRX7WbGZVDA703pNqOMQ==}engines: {node: '>=20.19.0'}@@ -6201,6 +6378,10 @@ packages:resolution: {integrity: sha512-cU8v/EGSrnH+HnxV2z0J7/blxH8gq7Xh2JFT6Aroax7UohdmiJJlxApMxtKfuI7z68NvvVcmR78k2LbT6efhRg==}engines: {node: '>= 18'}+ resolution: {integrity: sha512-dq9AtApgg5PGFtBzPFSBl3HZQjHok5gaQCM6zh2Yk0aSmDCs1CbnVI8/HgASQkNKsWFpseIO9beg5xxpYhbIfA==}+ engines: {node: 20.x || 22.x || 23.x || 24.x || 25.x || 26.x}+resolution: {integrity: sha512-fX1Onk0tdVPC7obPWB5EbJ1z7NVhLq4m2xZLq2YXBkxzMXIGRpNMU88n0EPgWseKl12J7zXs7qrDxPK4sRs2fg==}@@ -6211,6 +6392,9 @@ packages:resolution: {integrity: sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==}engines: {node: '>=8'}+ resolution: {integrity: sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==}+resolution: {integrity: sha512-KkemzKFH4T3gt3H+P86JcnAWExjByv/6vlwjm/BoCwTPHu03yiCdxbghdJLvFReQTe0acCAiRcKfmixxD6XvlA==}engines: {node: '>=20'}@@ -6619,6 +6803,10 @@ packages:resolution: {integrity: sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw==}engines: {node: '>=18'}+ resolution: {integrity: sha512-H+y0Jo/T1RZ9qPP4Eh1pkcQcLRglraJaSLoyOtHxu6AapkjWVCy2Sit1QQ4x3Dng8qDlSsZEet7g5Pq06MvTgw==}+ engines: {node: '>=20'}+resolution: {integrity: sha512-z67u4ZhzCL/Tydu1lJARtEZYWbWaN7oYLHbsuzocr6y4N6WZAagG3RQ4FW61V1/0+jImpj293XfrcYnd1qxtPg==}engines: {node: '>=22.12.0'}@@ -6749,6 +6937,10 @@ packages:resolution: {integrity: sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==}engines: {node: '>= 0.6'}+ resolution: {integrity: sha512-ei8Aos7ja0weRpFzJnEA9UHJ/7XQmqglbRwnf2ATjcB9Wq874VKH9kfjjirM6UhU2/E5fFYadylyhFldcqSidQ==}+ engines: {node: '>=18'}+resolution: {integrity: sha512-yuToqVvRrj6pfDXREyQAAv8SkAEk/8GS3jQRTiUMm66TVtBYmqQeoEjL2Lmq8Rpo6271vH76InTChTitEAm65w==}engines: {node: '>=22'}@@ -6823,10 +7015,17 @@ packages:resolution: {integrity: sha512-JfAYMY0LZaWQTuict8PhtF/ksSnq8xefSDmQUnnoqvkPYkU/y3UP0DTWzJKFBz0P1IXsDG8q0vY3zHkoFZOhvw==}engines: {node: '>=18'}+ resolution: {integrity: sha512-jcu8g/3wZL8OBr4MkEcbeIdLpM8pp5Y6UoOlRktcJG3WjgpifijR0s26Yac7ywR0gC2ABtevOsz5mlD3l3gzwA==}+resolution: {integrity: sha512-fkdfq+b+AHI4cKdhZlppHveI/mgz2qpiYxcm+t5E5TsxX7QrLS1VE0+7GENEk9z0EeGPcpSciGv6ez24duWhwQ==}engines: {node: '>=18.x'}+ resolution: {integrity: sha512-i10xR7fS4AH9LKwmt3gYdt/5lSsB2qFGSNfC8aeyYybxo48DCMz+nUrSVI4kUj8yo+SgTbMJqp/BWEem9avlcA==}+ hasBin: true+resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==}engines: {node: '>= 8'}@@ -7796,6 +7995,9 @@ packages:resolution: {integrity: sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==}+ resolution: {integrity: sha512-qZDD6u86YMB15jps0ZYDE7fxJl2EZsxspagUcLg6K3k/WKRkGGpXM/5kk5a2UvX5+yv6viQ1jYYr1De4IiBx/w==}+resolution: {integrity: sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==}@@ -7821,10 +8023,16 @@ packages:resolution: {integrity: sha512-D9rRn9y7kLPnJ+hMq7S/nhvoKwwvVJahBi2BPmx3bvbsEdK3W9ii8cBSGjP+72/LnM4n6fo3+dkCX5FeTQruXA==}+ resolution: {integrity: sha512-KGft0ldl31BZVV//jj+IAIGCxkvvUkkON+ScH6zfoX+l+omX6001ggyRSpI0Io2Hlro0ThXotswCtfzS8UkIiQ==}+resolution: {integrity: sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==}engines: {node: '>=6'}+ resolution: {integrity: sha512-JEPTiaOt9f04oa6NOkc4aH+nVp5I3wEjpHbIPqfgCdD5v5bUzy7xQqwcVO2aDQgOWhI28da57HksMrzK9HlRxg==}+resolution: {integrity: sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==}@@ -7835,6 +8043,14 @@ packages:resolution: {integrity: sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==}engines: {node: '>=0.8.x'}+ resolution: {integrity: sha512-kDI75RSzO3TwyG/K9w1ap8XwqSPcwi6jaMkNulfVeZmSeUM49U8kUzk1s+vKNt0tGrXgK47i+620Yasn1ccFiw==}+ engines: {node: '>=18.0.0'}++ resolution: {integrity: sha512-EKN1vKAMcZ8MlYMpaNuxN6R9yakzH6uajHcHVTqWJzvu5pWw9DyhbP35HH8MVBQ+dZjAfDxk+A8NiR9KWaXiyQ==}+ engines: {node: '>=18.0.0'}+resolution: {integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==}engines: {node: '>=10'}@@ -7969,6 +8185,9 @@ packages:resolution: {integrity: sha512-sEB0oStmeLGtpmSAD88RDNuLsvhv4iC3u0lE25CUvfCULvj49xoQ3l3K525Vn+ZzsZ6DOLajQCV6RmhwwhqiJg==}engines: {node: '>=22'}+ resolution: {integrity: sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==}+resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==}engines: {node: '>=8'}@@ -8950,10 +9169,18 @@ packages:resolution: {integrity: sha512-nO6jcEfZWQXDhOiBtG2KvKyEptz7RVbpGP4vTD2hLBdmNQSsCiicO2Ioinv6UI4y9ukqnBpy+XZ9H6uLNgJTlw==}+ resolution: {integrity: sha512-zrteXnqYxfQh7l5FHyL38jL39di8H8rHoecLH3JNxH3BwOrBsNeabdap5e0I23lD4HHI8W5VFBZqG4Eaq5LNcw==}+ engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}+resolution: {integrity: sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==}engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}+ resolution: {integrity: sha512-ZB7wHqaRGVw/9hST/OuFUReG7M8vKeq0/J2egIGLdvjHCmYqGARhzXmtgi+gVeZ5uXFF219aOc3Ls2yLg27tkw==}+ engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}+resolution: {integrity: sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==}engines: {node: '>= 10.13.0'}@@ -8984,6 +9211,9 @@ packages:resolution: {integrity: sha512-7TIg10ZE1x82YediN+lcrPNvGMKge9yFHQD+Qho/b8y2adfugU3AsvvHfxV0fzyFllT6l9xCjf4RWY9g/Z9PJQ==}+ resolution: {integrity: sha512-5obBtsz9301ULlsgggLg542s/jqtddfOpV5KJc4hajc9JV8GeY2gZHSVpYBn4nWqAUTJ9v+xwtbJ1mIBgIH5Vw==}+resolution: {integrity: sha512-lM/UBzQmfJRo9ABXbPWemivdCW8V2G8FHaHdypQaIy523snUjog0W71ayWXTjiR+ixeMyVHN2XcpnTd/liPg/Q==}@@ -9124,6 +9354,10 @@ packages:postgres:optional: true+ resolution: {integrity: sha512-nbD8lB9EB3wNdMhOCdx5Li8DxnLbvKByylRLcJ1h+4SkrowVeECAyZlyiKMThF7xFdRz0jSQ2MoJr+wXux2y0Q==}+ engines: {node: '>=20.0.0'}+resolution: {integrity: sha512-fmIq+7kv4WbFm2tcfznRzikqB4cuNpgZ40PSU2fAJ2/OO5XhojqnTPrmgrCjYSRJVwBln03XcRXJGnw9H099IQ==}engines: {node: '>=22.0.0'}@@ -10517,6 +10751,10 @@ packages:resolution: {integrity: sha512-LKWqWJRhstyYo9pGvgor/ivk2w94eSjE3RGVuzLGlr3NmD8bf7RcYGze1mNdEHRP6TRP6rMuDHk5t44hnTRyow==}engines: {node: '>=14.19.0'}+ resolution: {integrity: sha512-sz1pnjgEfPyZ+QvaeX3NtCmbYnEvG01LZRLoN/uXoLtPZtxCIH5IctL7yXXc0fFyk/fqV6K8g3hlNfr6IJwupA==}+ engines: {node: '>=20'}+resolution: {integrity: sha512-x2pcvXeqhRHlNRdhLs/tgFapAbSSe86wa/eqmj1G6pWftbEs5aVRJhRGM6FYSUERKu0PjekJzMq0gsI2XyiclQ==}@@ -11061,6 +11299,10 @@ packages:resolution: {integrity: sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==}engines: {node: ^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0}+ resolution: {integrity: sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ==}+ engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}+resolution: {integrity: sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==}engines: {node: '>=4'}@@ -11099,6 +11341,9 @@ packages:resolution: {integrity: sha512-WPn+h9RGEExOKdu4bsF4HksG/uzd3cFq3MFtq8PsFeExPse5Ha/VOjQNyHhjboBFwGXGev6muJYTSPAOkROq2g==}engines: {node: '>=18'}+ resolution: {integrity: sha512-SVtmxhRE/CGkn3eZY1T6pC8Nln6Fr/lu1mKSgRud0eC73whjGfoAogbn78LkD8aFL0zz3bAFerKSnOl7NlErBA==}+resolution: {integrity: sha512-YUHSPk+A30YPv+0Qf8i9Mbfe/C0hdPXk1s1jPVToV8pk8BQtpw10ct89Eo7OWkutrwqvT0eicAxlOg3dOAu8JA==}@@ -11119,6 +11364,11 @@ packages:resolution: {integrity: sha512-5nnx0yGyVUcY6t9RnWcARWtwT9F1D8O9rt08htPvnd49W1IgZtmLkhu9WfMzQj1cFxjHIO6connUNVW5k7AVyQ==}engines: {node: '>= 0.10'}+ resolution: {integrity: sha512-jBidehQu5WO8zbFUod0ETJYoVPxZ0ixsdI9B8ilkE0eA+YTydxHA7ujNdU4YhTexD5yH5Griv9r5CuXx+nwFUA==}+ engines: {node: '>=24.0.0'}+ hasBin: true+resolution: {integrity: sha512-VS7sjc6KR7e1ukRFhQSY5LM2uBWAUPiOPa/A3mkKmiMwSmRFUITt0xuj+/lesgnCv+dPIEYlkzrcyXgquIHMcA==}@@ -11237,6 +11487,9 @@ packages:resolution: {integrity: sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==}+ resolution: {integrity: sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==}+resolution: {integrity: sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g==}engines: {node: '>=18'}@@ -12079,6 +12332,13 @@ packages:resolution: {integrity: sha512-0C8qDLIc825IWRyLqj9XNu762mV4hXtkKhnY8tyXreyakIyRYYUfgxJUwulFQa4mSQ/kra+jJDvKeoem8T4xYA==}+ resolution: {integrity: sha512-HxVsn56T4qt6ScNhaMBvkSv1Wy962NZUXjmXe7SnHZzXrkHgK2Is6zwa3knaXP5u2t/mSf/cTemOcEFTBBpnww==}+ peerDependencies:+ '@lingui/cli': '>=4'+ '@lingui/core': '>=4'+ svelte: '>=4'+resolution: {integrity: sha512-jaykGlGT5PUaaq04JWbJREvivlCnALtT+m87Kbm0fxyYHynkQaxQMnIKHLm2WeIuBRoljzwgyvz0Z6/CMwfdmQ==}engines: {node: '>= 16'}@@ -12325,6 +12585,9 @@ packages:resolution: {integrity: sha512-wFH7+SEAcKfJpfLPkrgMPvvwnEtj8W4IurvEyrKsDleXnKLCDw71w8jltvfLa8Rm4qQxxT4jmDBYbJG/z7qoww==}engines: {node: '>=0.12'}+ resolution: {integrity: sha512-Eet/eeMhkO6TX8mnUteS9zgPbUMQa4I6Kkp5ORiBD5476/m+PIRiumP5tmh5ioJpH7k51Kehawy2UDfsnxxY8Q==}+resolution: {integrity: sha512-g/55ssRPUjShh+xkfx9UPDXqhckHEsHr4Vd9zX55oSdGZc/MD0m3sferOkwWtp98bv+kcVfEHtRJgBVJzelrzg==}@@ -12350,6 +12613,10 @@ packages:resolution: {integrity: sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==}engines: {node: ^18.0.0 || >=20.0.0}+ resolution: {integrity: sha512-jBrmx4lYmaC9k/mgPbylxs7kBUxHtD8256up+HjLaDFfXScKJQyil+SWXSvhAtT7XHo+yTVlpB81PGmHP8oLSQ==}+ engines: {node: ^20.0.0 || >=22.0.0}+resolution: {integrity: sha512-gRa9gwYU3ECmQYv3lslts5hxuIa90veaEcxDYuu3QGOIAEM2mOZkVHp48ANJuu1CURtRdHKUBY5Lm1tHV+sD4g==}@@ -12383,6 +12650,9 @@ packages:resolution: {integrity: sha512-dRXchy+C0IgK8WPC6xvCHFRIWYUbqqdEIKPaKo/AcTUNzwLTK6AH7RjdLWsEZcAN/TBdtfUw3PYEgPr5VPr6ww==}engines: {node: '>=14.16'}+ resolution: {integrity: sha512-0a5EOkAUp8D4moMi2W8ZF8jcga7BgZd91O/yabJCFY8az+XSzeGyTKs0Aoo897iV1Nj6guFq8orWDS96z91oGg==}+resolution: {integrity: sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==}engines: {node: '>=6'}@@ -13233,6 +13503,9 @@ packages:resolution: {integrity: sha512-xYqdZFUK/VYazNl/oCDYN+3WloWQwMfZxBoiNt6qNyk+xfOdi598muWE42rNZFp1kNOiqW936q5RhUdnpqElSg==}engines: {node: '>=18'}+ resolution: {integrity: sha512-GKHFX2nXul2/4Dtfxhozv701jLQHdf6J34YDh2cEkpqoo8le5Mg6/LrdseVLrFarmFygZTlfIhHx/QKfb/QWXw==}+resolution: {integrity: sha512-B58NGBEoc8Y9MWWCQGl/gq9xBCe4IiKM0a2x7GZdQKOW5Exr8S1W24J6OgM1njK8xCRGvAJIL/MxXHf6SkmQKQ==}@@ -15865,6 +16138,70 @@ snapshots:dependencies:'@fortawesome/fontawesome-common-types': 7.3.1+ '@futo-org/[email protected]':+ dependencies:+ '@oazapfts/runtime': 1.2.0++ '@futo-org/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])(@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected]))(@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@typescript/[email protected])([email protected]))(@nestjs/[email protected])([email protected])([email protected])':+ dependencies:+ '@futo-org/backups-api-client': 1.11.5+ '@futo-org/restic-wrapper': 1.7.0+ '@nestjs/core': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])([email protected])([email protected])+ '@nestjs/event-emitter': 12.0.1(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])+ '@nestjs/jwt': 12.0.3(@nestjs/[email protected]([email protected])([email protected])([email protected]))+ '@nestjs/platform-socket.io': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])([email protected])([email protected])+ '@nestjs/schedule': 12.0.2(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])+ '@nestjs/swagger': 12.0.3(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@typescript/[email protected])([email protected])+ '@nestjs/websockets': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])([email protected])([email protected])+ better-sqlite3: 12.11.1+ cookie: 1.1.1+ cron: 4.4.0+ event-iterator: 2.0.0+ eventsource-client: 1.2.0+ express: 5.3.0([email protected])+ kysely: 0.28.17+ nestjs-kysely: 3.1.4(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])([email protected])([email protected])+ nestjs-zod: 5.5.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@typescript/[email protected])([email protected]))([email protected])([email protected])+ openid-client: 6.8.8+ rxjs: 7.8.2+ socket.io: 4.8.4([email protected])+ zod: 4.4.3+ transitivePeerDependencies:+ - bufferutil+ - reflect-metadata+ - supports-color+ - utf-8-validate++ '@futo-org/[email protected](@immich/[email protected](@sveltejs/[email protected](@opentelemetry/[email protected])(@sveltejs/[email protected]([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))(@typescript/[email protected])([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected](@typescript-eslint/[email protected]))([email protected]))(@lingui/[email protected]([email protected])([email protected])([email protected]))(@typescript/[email protected])([email protected])([email protected](@typescript-eslint/[email protected]))':+ dependencies:+ '@futo-org/backups-api-client': 1.11.5+ '@immich/ui': 0.91.1(@sveltejs/[email protected](@opentelemetry/[email protected])(@sveltejs/[email protected]([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))(@typescript/[email protected])([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected](@typescript-eslint/[email protected]))([email protected])+ '@lingui/core': 5.9.5+ '@material-symbols/svg-400': 0.48.2+ '@mdi/js': 7.4.47+ '@oazapfts/runtime': 1.2.0+ '@tanstack/svelte-query': 6.3.5([email protected](@typescript-eslint/[email protected]))+ cron-validate: 1.5.3+ cronstrue: 3.38.0+ lodash.debounce: 4.0.8+ luxon: 3.7.2+ socket.io-client: 4.8.4([email protected])+ svelte: 5.57.2(@typescript-eslint/[email protected])+ svelte-i18n-lingui: 0.2.2(@lingui/[email protected]([email protected])([email protected])([email protected]))(@lingui/[email protected])(@typescript/[email protected])([email protected])([email protected](@typescript-eslint/[email protected]))+ transitivePeerDependencies:+ - '@lingui/babel-plugin-lingui-macro'+ - '@lingui/cli'+ - babel-plugin-macros+ - bufferutil+ - supports-color+ - typescript+ - utf-8-validate++ '@futo-org/[email protected]':+ dependencies:+ zod: 4.4.3+'@golevelup/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])':dependencies:@@ -16438,6 +16775,126 @@ snapshots:dependencies:'@lezer/common': 1.5.2+ '@lingui/[email protected]':+ dependencies:+ '@lingui/conf': 6.10.1++ dependencies:+ '@lingui/conf': 6.10.1+ '@lingui/message-utils': 6.10.1+ optionalDependencies:+ '@babel/core': 7.29.7([email protected])++ dependencies:+ '@babel/core': 7.29.7([email protected])+ '@babel/generator': 7.29.8+ '@babel/parser': 7.29.9+ '@babel/types': 7.29.8+ '@lingui/babel-plugin-extract-messages': 6.10.1+ '@lingui/babel-plugin-lingui-macro': 6.10.1(@babel/[email protected]([email protected]))+ '@lingui/conf': 6.10.1+ '@lingui/core': 6.10.1(@babel/[email protected]([email protected]))+ '@lingui/format-po': 6.10.1+ '@lingui/message-utils': 6.10.1+ '@lingui/native-tools': 0.1.6(@lingui/[email protected])+ chokidar: 5.0.0+ cli-table3: 0.6.5+ commander: 14.0.3+ jiti: 2.7.0+ micromatch: 4.0.8+ ms: 2.1.3+ normalize-path: 3.0.0+ ora: 9.4.1+ pseudolocale: 3.1.0+ source-map: 0.7.6+ tinypool: 2.2.0+ optionalDependencies:+ esbuild: 0.28.2+ rolldown: 1.2.15+ transitivePeerDependencies:+ - babel-plugin-macros+ - supports-color++ '@lingui/[email protected]':+ dependencies:+ jest-validate: 29.7.0+ jiti: 2.7.0+ lilconfig: 3.1.3+ normalize-path: 3.0.0++ '@lingui/[email protected]':+ dependencies:+ '@babel/runtime': 7.29.7+ '@lingui/message-utils': 5.9.5++ dependencies:+ '@lingui/babel-plugin-lingui-macro': 6.10.1(@babel/[email protected]([email protected]))+ '@lingui/message-utils': 6.10.1+ transitivePeerDependencies:+ - '@babel/core'++ '@lingui/[email protected]':+ dependencies:+ '@lingui/conf': 6.10.1+ '@lingui/message-utils': 6.10.1+ pofile-ts: 4.0.3++ '@lingui/[email protected]':+ dependencies:+ '@messageformat/parser': 5.2.0+ js-sha256: 0.10.1++ '@lingui/[email protected]':+ dependencies:+ '@messageformat/date-skeleton': 1.1.0+ '@messageformat/parser': 5.2.0+ js-sha256: 0.10.1++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected]':+ optional: true++ '@lingui/[email protected](@lingui/[email protected])':+ dependencies:+ '@lingui/conf': 6.10.1+ '@swc/types': 0.1.28+ optionalDependencies:+ '@lingui/native-tools-android-arm64': 0.1.6+ '@lingui/native-tools-darwin-arm64': 0.1.6+ '@lingui/native-tools-darwin-x64': 0.1.6+ '@lingui/native-tools-linux-arm64-gnu': 0.1.6+ '@lingui/native-tools-linux-arm64-musl': 0.1.6+ '@lingui/native-tools-linux-x64-gnu': 0.1.6+ '@lingui/native-tools-linux-x64-musl': 0.1.6+ '@lingui/native-tools-win32-arm64-msvc': 0.1.6+ '@lingui/native-tools-win32-x64-msvc': 0.1.6+'@lukeed/[email protected]': {}'@mapbox/[email protected]': {}@@ -16494,6 +16951,8 @@ snapshots:'@marijn/[email protected]': {}+ '@material-symbols/[email protected]': {}+'@mdi/[email protected]': {}'@mdi/[email protected]':@@ -16546,6 +17005,12 @@ snapshots:dependencies:'@chevrotain/types': 11.1.2+ '@messageformat/[email protected]': {}++ '@messageformat/[email protected]':+ dependencies:+ moo: 0.5.3+'@microsoft/[email protected]': {}'@msgpackr-extract/[email protected]':@@ -16643,6 +17108,18 @@ snapshots:'@nestjs/platform-express': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])([email protected])'@nestjs/websockets': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])([email protected])([email protected])+ '@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])':+ dependencies:+ '@nestjs/core': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])([email protected])([email protected])+ eventemitter2: 6.4.9++ '@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))':+ dependencies:+ '@types/jsonwebtoken': 9.0.10+ jsonwebtoken: 9.0.3+'@nestjs/[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))([email protected])':dependencies:@@ -19149,6 +19626,11 @@ snapshots:node-gyp: 13.1.0node-gyp-build: 4.8.4+ dependencies:+ bindings: 1.5.0+ prebuild-install: 7.1.3+dependencies:require-from-string: 2.0.2@@ -19157,6 +19639,10 @@ snapshots:+ dependencies:+ file-uri-to-path: 1.0.0+[email protected](@internationalized/[email protected])(@sveltejs/[email protected](@opentelemetry/[email protected])(@sveltejs/[email protected]([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))(@typescript/[email protected])([email protected](@typescript-eslint/[email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected](@typescript-eslint/[email protected])):dependencies:'@floating-ui/core': 1.8.0@@ -19578,6 +20064,8 @@ snapshots:+ [email protected]: {}+@@ -19705,6 +20193,8 @@ snapshots:+ [email protected]: {}+@@ -19780,11 +20270,17 @@ snapshots:dependencies:luxon: 3.7.2+ dependencies:+ yup: 1.7.1+dependencies:'@types/luxon': 3.7.6luxon: 3.7.2+ [email protected]: {}+dependencies:path-key: 3.1.1@@ -20998,6 +21494,8 @@ snapshots:'@types/estree-jsx': 1.0.5'@types/unist': 3.0.3+ [email protected]: {}+@@ -21020,8 +21518,12 @@ snapshots:d: 1.0.2es5-ext: 0.10.64+ [email protected]: {}++ [email protected]: {}+@@ -21032,6 +21534,12 @@ snapshots:+ dependencies:+ eventsource-parser: 3.1.1++ [email protected]: {}+dependencies:cross-spawn: 7.0.6@@ -21060,8 +21568,7 @@ snapshots:optionalDependencies:exiftool-vendored.exe: 13.59.3- optional: true+ [email protected]: {}@@ -21241,6 +21748,8 @@ snapshots:transitivePeerDependencies:- supports-color+ [email protected]: {}+dependencies:to-regex-range: 5.0.1@@ -21487,8 +21996,7 @@ snapshots:dependencies:resolve-pkg-maps: 1.0.0- optional: true+ [email protected]: {}@@ -22400,6 +22908,8 @@ snapshots:+ [email protected]: {}+dependencies:'@jest/types': 29.6.3@@ -22409,6 +22919,15 @@ snapshots:graceful-fs: 4.2.11picomatch: 2.3.2+ dependencies:+ '@jest/types': 29.6.3+ camelcase: 6.3.0+ chalk: 4.1.2+ jest-get-type: 29.6.3+ leven: 3.1.0+ pretty-format: 29.7.0+dependencies:'@types/node': 24.19.2@@ -22440,6 +22959,8 @@ snapshots:+ [email protected]: {}+@@ -22633,6 +23154,8 @@ snapshots:optionalDependencies:postgres: 3.4.9+ [email protected]: {}+@@ -23684,8 +24207,7 @@ snapshots:- optional: true+ [email protected]: {}@@ -23731,6 +24253,14 @@ snapshots:reflect-metadata: 0.2.2rxjs: 7.8.2+ [email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])([email protected])([email protected]):+ dependencies:+ '@nestjs/core': 12.2.0(@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])(@nestjs/[email protected])([email protected])([email protected])+ kysely: 0.28.17+ reflect-metadata: 0.2.2+ tslib: 2.8.1+[email protected](@nestjs/[email protected]([email protected])([email protected])([email protected]))(@nestjs/[email protected])([email protected])([email protected]):dependencies:@@ -23767,7 +24297,6 @@ snapshots:dependencies:semver: 7.8.5- optional: true@@ -24261,6 +24790,8 @@ snapshots:+ [email protected]: {}+dependencies:robust-predicates: 3.0.3@@ -24789,7 +25320,6 @@ snapshots:simple-get: 4.0.1tar-fs: 2.1.5tunnel-agent: 0.6.0- optional: true@@ -24824,6 +25354,12 @@ snapshots:ansi-styles: 5.2.0react-is: 17.0.2+ dependencies:+ '@jest/schemas': 29.6.3+ ansi-styles: 5.2.0+ react-is: 18.3.1+@@ -24864,6 +25400,8 @@ snapshots:transitivePeerDependencies:- supports-color+ [email protected]: {}+dependencies:xtend: 4.0.2@@ -24893,6 +25431,10 @@ snapshots:forwarded: 0.2.0ipaddr.js: 1.9.1+ dependencies:+ commander: 13.1.0+dependencies:end-of-stream: 1.4.5@@ -25028,6 +25570,8 @@ snapshots:+ [email protected]: {}+dependencies:react: 19.3.1@@ -25788,15 +26332,13 @@ snapshots:- optional: true+ [email protected]: {}dependencies:decompress-response: 6.0.0once: 1.4.0simple-concat: 1.0.1- optional: true@@ -26186,6 +26728,18 @@ snapshots:dependencies:highlight.js: 11.11.1+ [email protected](@lingui/[email protected]([email protected])([email protected])([email protected]))(@lingui/[email protected])(@typescript/[email protected])([email protected])([email protected](@typescript-eslint/[email protected])):+ dependencies:+ '@lingui/core': 5.9.5+ '@typescript-eslint/typescript-estree': 8.72.0(@typescript/[email protected])([email protected])+ estree-walker-ts: 1.1.0+ js-sha256: 0.10.1+ svelte: 5.57.2(@typescript-eslint/[email protected])+ transitivePeerDependencies:+ - supports-color+ - typescript+dependencies:cli-color: 2.0.4@@ -26503,6 +27057,8 @@ snapshots:es5-ext: 0.10.64next-tick: 1.1.0+ [email protected]: {}+dependencies:globalyzer: 0.1.0@@ -26523,6 +27079,8 @@ snapshots:+ [email protected]: {}+@@ -26554,6 +27112,8 @@ snapshots:'@tokenizer/token': 0.3.0ieee754: 1.2.1+ [email protected]: {}+@@ -26634,7 +27194,6 @@ snapshots:dependencies:safe-buffer: 5.2.1- optional: true@@ -27552,6 +28111,13 @@ snapshots:+ dependencies:+ property-expr: 2.0.6+ tiny-case: 1.0.3+ toposort: 2.0.2+ type-fest: 2.19.0+diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yamlindex 3825373faf..09c5763526 100644--- a/pnpm-workspace.yaml+++ b/pnpm-workspace.yaml@@ -14,6 +14,7 @@ allowBuilds:'@scarf/scarf': false'@swc/core': falsebcrypt: true+ better-sqlite3: truecanvas: falsecore-js: falsecpu-features: false@@ -72,3 +73,4 @@ minimumReleaseAgeExclude:- '@immich/ui'- '@immich/[email protected] || 0.6.6'- '@nestjs/[email protected]'+ - '@futo-org/*'diff --git a/server/Dockerfile b/server/Dockerfileindex ac1f1434f5..7b2cbf21ba 100644--- a/server/Dockerfile+++ b/server/Dockerfile@@ -79,7 +79,6 @@ ENV MISE_DATA_DIR=/buildcache/miseENV MISE_DISABLE_TOOLS=flutterRUN --mount=type=cache,id=mise-tools-${TARGETPLATFORM},target=/buildcache/mise \mise install --locked-COPY ./packages/plugin-core ./packages/plugin-core/# Build plugins@@ -120,6 +119,9 @@ ENV IMMICH_SOURCE_REF=${BUILD_SOURCE_REF}ENV IMMICH_SOURCE_COMMIT=${BUILD_SOURCE_COMMIT}ENV IMMICH_SOURCE_URL=https://github.com/immich-app/immich/commit/${BUILD_SOURCE_COMMIT}+COPY --from=ghcr.io/futo-org/backups/restic-proxy:v1.11.2@sha256:a88252d884d22a55749f45dd39a2458c6391ca3e4d3b0d9e0c2246786cf923be /usr/local/bin/restic-proxy /usr/local/bin/restic-proxy+COPY --from=ghcr.io/futo-org/restic:sha-a24cc22@sha256:7b5cdba9cc8690ecc528e239e6f8b2cfb9ef3644895cafd0e0fa9003bcded1f6 /usr/bin/restic /usr/local/bin/restic+VOLUME /dataEXPOSE 2283ENTRYPOINT ["tini", "--", "/bin/bash", "-c"]diff --git a/server/Dockerfile.dev b/server/Dockerfile.devindex 4b9d0c4b8b..0bd2a74dd6 100644--- a/server/Dockerfile.dev+++ b/server/Dockerfile.dev@@ -3,6 +3,7 @@ FROM ghcr.io/immich-app/base-server-dev:202610291416@sha256:5f4f9f77059e1cd01829COPY --from=ghcr.io/jdx/mise:2026.10.20@sha256:a3023a390ce9d79343741039d35a36aa41e4fe8198464bf8cc9ffd23ae081a24 /usr/local/bin/mise /usr/local/bin/mise+COPY --from=ghcr.io/immich-app/futo-backups-restic-proxy:commit-6297cf30a3caf4101e1ca74247bb822ab1f56ee0 /usr/local/bin/restic-proxy /usr/local/bin/restic-proxyRUN echo "devdir=/buildcache/node-gyp" >> /usr/local/etc/npmrc && \echo "store-dir=/buildcache/pnpm-store" >> /usr/local/etc/npmrc && \diff --git a/server/package.json b/server/package.jsonindex e837440ede..cf0ec7ed31 100644--- a/server/package.json+++ b/server/package.json@@ -40,6 +40,7 @@},"dependencies": {"@extism/extism": "2.0.0-rc13",+ "@futo-org/backups-orchestrator-api": "1.11.5","@immich/plugin-sdk": "workspace:*","@immich/sql-tools": "^0.6.6","@nestjs/bullmq": "^12.0.0",diff --git a/server/src/app.module.ts b/server/src/app.module.tsindex 83bf21108e..9b64802388 100644--- a/server/src/app.module.ts+++ b/server/src/app.module.ts@@ -1,21 +1,26 @@+import { OrchestrationApiModule, controllers as futoBackupsControllers } from '@futo-org/backups-orchestrator-api';import { BullModule } from '@nestjs/bullmq';-import { Inject, Module, OnModuleDestroy, OnModuleInit } from '@nestjs/common';+import { Inject, Module, OnModuleDestroy, OnModuleInit, applyDecorators, forwardRef } from '@nestjs/common';import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core';import { ScheduleModule, SchedulerRegistry } from '@nestjs/schedule';+import { ApiExtension, ApiTags } from '@nestjs/swagger';import { ClsModule } from 'nestjs-cls';import { KyselyModule } from 'nestjs-kysely';import { OpenTelemetryModule } from 'nestjs-otel';import { ZodSerializerInterceptor, ZodValidationPipe } from 'nestjs-zod';+import { existsSync } from 'node:fs';+import { join } from 'node:path';import { commandsAndQuestions } from 'src/commands/index.js';import { IWorker } from 'src/constants.js';import { controllers } from 'src/controllers/index.js';-import { ImmichWorker } from 'src/enum.js';+import { HistoryBuilder } from 'src/decorators.js';+import { ApiTag, ImmichEnvironment, ImmichWorker } from 'src/enum.js';import { MaintenanceAuthGuard } from 'src/maintenance/maintenance-auth.guard.js';import { MaintenanceHealthRepository } from 'src/maintenance/maintenance-health.repository.js';import { MaintenanceWebsocketRepository } from 'src/maintenance/maintenance-websocket.repository.js';import { MaintenanceWorkerController } from 'src/maintenance/maintenance-worker.controller.js';import { MaintenanceWorkerService } from 'src/maintenance/maintenance-worker.service.js';-import { AuthGuard } from 'src/middleware/auth.guard.js';+import { AuthGuard, Authenticated } from 'src/middleware/auth.guard.js';import { ErrorInterceptor } from 'src/middleware/error.interceptor.js';import { FileUploadInterceptor } from 'src/middleware/file-upload.interceptor.js';import { GlobalExceptionFilter } from 'src/middleware/global-exception.filter.js';@@ -39,6 +44,7 @@ import { services } from 'src/services/index.js';import { QueueService } from 'src/services/queue.service.js';import { getKyselyConfig } from 'src/utils/database.js';import { configureUserAgent } from 'src/utils/fetch.js';+import { detectMediaLocation, getBackupsStatePath } from 'src/utils/storage.js';const common = [...repositories, ...services, GlobalExceptionFilter];@@ -53,7 +59,21 @@ const commonMiddleware = [const apiMiddleware = [FileUploadInterceptor, ...commonMiddleware, { provide: APP_GUARD, useClass: AuthGuard }];const configRepository = new ConfigRepository();-const { bull, cls, database, otel } = configRepository.getEnv();+const { bull, cls, database, environment, otel, storage } = configRepository.getEnv();++const isFutoBackupsDevelopmentMode = environment !== ImmichEnvironment.Production;+const futoBackupsStatePath = getBackupsStatePath(storage.mediaLocation);+const futoBackupsCachePath = join(detectMediaLocation(storage.mediaLocation, existsSync), 'restic-cache');++const futoBackupsHistory = new HistoryBuilder().added('v3.4.0').internal('v3.4.0').getExtensions();++for (const controller of futoBackupsControllers) {+ applyDecorators(+ Authenticated({ admin: true }),+ ApiTags(ApiTag.Backups),+ ...Object.entries(futoBackupsHistory).map(([key, value]) => ApiExtension(key, value)),+ )(controller);+}const commonImports = [ClsModule.forRoot(cls.config),@@ -103,14 +123,54 @@ export class BaseModule implements OnModuleInit, OnModuleDestroy {}@Module({- imports: [...bullImports, ...commonImports, ScheduleModule.forRoot()],+ imports: [+ ...bullImports,+ ...commonImports,+ ScheduleModule.forRoot(),+ OrchestrationApiModule.forRootAsync({+ imports: [forwardRef(() => ApiModule)],+ inject: [AuthService],+ useFactory: (authService: AuthService) => ({+ statePath: futoBackupsStatePath,+ cachePath: futoBackupsCachePath,+ requireWsAuth: true,+ requireLock: true,+ developmentMode: isFutoBackupsDevelopmentMode,+ authenticate: (client) =>+ authService.authenticate({+ headers: client.request.headers,+ queryParams: {},+ metadata: { adminRoute: true, sharedLinkRoute: false, uri: '/api/futo-backups/socket.io' },+ }),+ }),+ }),+ ],controllers: [...controllers],providers: [...common, ...apiMiddleware, { provide: IWorker, useValue: ImmichWorker.Api }],+ exports: [AuthService, WebsocketRepository],})export class ApiModule extends BaseModule {}@Module({- imports: [...commonImports],+ imports: [+ ...commonImports,+ OrchestrationApiModule.forRootAsync({+ imports: [forwardRef(() => MaintenanceModule)],+ inject: [MaintenanceWorkerService],+ useFactory: (maintenanceWorkerService: MaintenanceWorkerService) => ({+ statePath: futoBackupsStatePath,+ cachePath: futoBackupsCachePath,+ externalBaseUrl: 'https://my.immich.app',+ requireWsAuth: true,+ requireLock: true,+ developmentMode: isFutoBackupsDevelopmentMode,+ authenticate: async (client) => {+ await maintenanceWorkerService.authenticate(client.request.headers);+ return { user: { isAdmin: true } };+ },+ }),+ }),+ ],controllers: [MaintenanceWorkerController],providers: [ConfigRepository,@@ -129,6 +189,7 @@ export class ApiModule extends BaseModule {}{ provide: APP_GUARD, useClass: MaintenanceAuthGuard },{ provide: IWorker, useValue: ImmichWorker.Maintenance },],+ exports: [MaintenanceWorkerService, MaintenanceWebsocketRepository],})export class MaintenanceModule {constructor(diff --git a/server/src/constants.ts b/server/src/constants.tsindex a0b19d7541..f589ad12be 100644--- a/server/src/constants.ts+++ b/server/src/constants.ts@@ -153,6 +153,7 @@ export const endpointTags: Record<ApiTag, string> = {[ApiTag.AssetFiles]: 'An asset file is a file associated with an asset, including edited versions, thumbnails, etc.',[ApiTag.Authentication]: 'Endpoints related to user authentication, including OAuth.',[ApiTag.AuthenticationAdmin]: 'Administrative endpoints related to authentication.',+ [ApiTag.Backups]: 'FUTO Backups.',[ApiTag.ClusterGroups]:'A cluster group is a set of users whose faces are clustered together, so that a person can be shared between them.',[ApiTag.ConfigUser]: 'The system configuration properties that are visible to logged in users.',diff --git a/server/src/controllers/index.spec.ts b/server/src/controllers/index.spec.tsindex e156e01b07..2817fa825c 100644--- a/server/src/controllers/index.spec.ts+++ b/server/src/controllers/index.spec.ts@@ -92,7 +92,7 @@ const getRoutes = () => {id: `${method} ${path}`,label: `${Controller.name}.${name} (${method} /${path})`,path,- auth: getAuthenticatedOptions(reflector, handler),+ auth: getAuthenticatedOptions(reflector, [handler]),};});});diff --git a/server/src/dtos/config.dto.ts b/server/src/dtos/config.dto.tsindex 63620b7d02..8cd22e537d 100644--- a/server/src/dtos/config.dto.ts+++ b/server/src/dtos/config.dto.ts@@ -163,6 +163,7 @@ const AdminConfigSchemaWithVisibility = z.object({backup: z.object({+ beta: configBool.default(false).optional().describe('Whether the backups feature is enabled'),database: z.object({enabled: configBool.describe('Enabled'),@@ -584,6 +585,7 @@ export function mapPublicConfig(config: SystemConfig): PublicConfigDto {export const defaults = Object.freeze<SystemConfig>({backup: {+ beta: false,database: {enabled: true,cronExpression: CronExpression.EVERY_DAY_AT_2AM,diff --git a/server/src/dtos/maintenance.dto.ts b/server/src/dtos/maintenance.dto.tsindex 3b9ffc9b75..4bb7f35e11 100644--- a/server/src/dtos/maintenance.dto.ts+++ b/server/src/dtos/maintenance.dto.ts@@ -6,6 +6,8 @@ const SetMaintenanceModeSchema = z.object({action: MaintenanceActionSchema,restoreBackupFilename: z.string().optional().describe('Restore backup filename'),+ rollbackRepositoryId: z.string().optional().describe('Rollback repository ID'),+ rollbackSnapshotId: z.string().optional().describe('Rollback snapshot ID'),}).refine((data) => data.action !== MaintenanceAction.RestoreDatabase || (data.restoreBackupFilename?.length ?? 0) > 0,@@ -32,6 +34,7 @@ const MaintenanceStatusResponseSchema = zprogress: z.int().optional(),task: z.string().optional(),error: z.string().optional(),+ futoBackupsJobId: z.string().optional().describe('FUTO Backups job ID'),}).meta({ id: 'MaintenanceStatusResponseDto' });diff --git a/server/src/dtos/server.dto.ts b/server/src/dtos/server.dto.tsindex 2e4e9f99ee..6b2ef44c76 100644--- a/server/src/dtos/server.dto.ts+++ b/server/src/dtos/server.dto.ts@@ -142,6 +142,7 @@ const ServerFeaturesSchema = zconfigFile: z.boolean().describe('Whether config file is available'),facialRecognition: z.boolean().describe('Whether facial recognition is enabled'),map: z.boolean().describe('Whether map feature is enabled'),+ backups: z.boolean().describe('Whether the backups feature is enabled'),trash: z.boolean().describe('Whether trash feature is enabled'),reverseGeocoding: z.boolean().describe('Whether reverse geocoding is enabled'),importFaces: z.boolean().describe('Whether face import is enabled'),diff --git a/server/src/enum.ts b/server/src/enum.tsindex 4f69ddf258..6231d63c3d 100644--- a/server/src/enum.ts+++ b/server/src/enum.ts@@ -1031,6 +1031,7 @@ export enum DatabaseLock {VersionCheck = 800,HlsSessionCleanup = 850,FacialRecognition = 900,+ FutoBackupsModuleConfig = 926,DuplicateDetection = 1000,}@@ -1039,6 +1040,7 @@ export enum MaintenanceAction {End = 'end',SelectDatabaseRestore = 'select_database_restore',RestoreDatabase = 'restore_database',+ Rollback = 'rollback',}export const MaintenanceActionSchema = z@@ -1263,6 +1265,7 @@ export enum ApiTag {AuthenticationAdmin = 'Authentication (admin)',Assets = 'Assets',AssetFiles = 'Asset files',+ Backups = 'Backups',ConfigUser = 'Config (user)',ConfigAdmin = 'Config (admin)',ConfigPublic = 'Config (public)',diff --git a/server/src/maintenance/maintenance-auth.guard.ts b/server/src/maintenance/maintenance-auth.guard.tsindex 8533b171c0..31c8363383 100644--- a/server/src/maintenance/maintenance-auth.guard.ts+++ b/server/src/maintenance/maintenance-auth.guard.ts@@ -1,4 +1,5 @@-import { CanActivate, ExecutionContext, Injectable, SetMetadata, applyDecorators } from '@nestjs/common';+import { controllers as futoBackupsControllers } from '@futo-org/backups-orchestrator-api';+import { CanActivate, ExecutionContext, Injectable, SetMetadata, Type, applyDecorators } from '@nestjs/common';import { Reflector } from '@nestjs/core';import { Request } from 'express';import { MaintenanceAuthDto } from 'src/dtos/maintenance.dto.js';@@ -26,16 +27,19 @@ export class MaintenanceAuthGuard implements CanActivate {}async canActivate(context: ExecutionContext): Promise<boolean> {+ const request = context.switchToHttp().getRequest<MaintenanceAuthRequest>();+const targets = [context.getHandler()];const options = this.reflector.getAllAndOverride<{ _emptyObject: never } | undefined>(MetadataKey.AuthRoute,targets,);- if (!options) {++ const isFutoBackupsRoute = (futoBackupsControllers as Type[]).includes(context.getClass());+ if (!options && !isFutoBackupsRoute) {return true;}- const request = context.switchToHttp().getRequest<MaintenanceAuthRequest>();request.auth = await this.service.authenticate(request.headers);return true;diff --git a/server/src/maintenance/maintenance-health.repository.spec.ts b/server/src/maintenance/maintenance-health.repository.spec.tsnew file mode 100644index 0000000000..9fd9b0e1bb--- /dev/null+++ b/server/src/maintenance/maintenance-health.repository.spec.ts@@ -0,0 +1,110 @@+import { ChildProcess, fork } from 'node:child_process';+import { EventEmitter } from 'node:events';+import { MaintenanceHealthRepository } from 'src/maintenance/maintenance-health.repository.js';++vi.mock('node:child_process', () => ({ fork: vi.fn() }));++const createWorker = () => {+ const worker = Object.assign(new EventEmitter(), { kill: vi.fn() });+ worker.kill.mockImplementation((signal: NodeJS.Signals) => {+ worker.emit('exit', null, signal);+ return true;+ });+ return worker;+};++const refused = () => Promise.reject(new TypeError('fetch failed'));+const respond = (ok: boolean) => Promise.resolve({ ok } as Response);++describe(MaintenanceHealthRepository.name, () => {+ let sut: MaintenanceHealthRepository;+ let worker: ReturnType<typeof createWorker>;+ let fetchMock: ReturnType<typeof vi.fn<typeof fetch>>;++ beforeEach(() => {+ vi.useFakeTimers();+ sut = new MaintenanceHealthRepository();+ worker = createWorker();+ vi.mocked(fork).mockReturnValue(worker as unknown as ChildProcess);+ fetchMock = vi.fn<typeof fetch>();+ vi.stubGlobal('fetch', fetchMock);+ });++ afterEach(() => {+ vi.unstubAllGlobals();+ vi.useRealTimers();+ });++ describe('checkApiHealth', () => {+ it('should start the api worker on the health check address', async () => {+ fetchMock.mockImplementation(() => respond(true));++ const promise = sut.checkApiHealth();+ await vi.advanceTimersByTimeAsync(1000);+ await promise;++ expect(fork).toHaveBeenCalledWith(+ expect.stringMatching(/workers\/api\.js$/),+ [],+ expect.objectContaining({+ env: expect.objectContaining({ IMMICH_HOST: '127.0.0.1', IMMICH_PORT: '33001' }),+ }),+ );+ });++ it('should resolve once the api worker answers the ping endpoint', async () => {+ fetchMock+ .mockImplementationOnce(refused)+ .mockImplementationOnce(refused)+ .mockImplementation(() => respond(true));++ const promise = sut.checkApiHealth();+ await vi.advanceTimersByTimeAsync(3000);++ await expect(promise).resolves.toBeUndefined();+ expect(fetchMock).toHaveBeenCalledTimes(3);+ expect(fetchMock).toHaveBeenCalledWith('http://127.0.0.1:33001/api/server/ping', expect.anything());+ expect(worker.kill).toHaveBeenCalledWith('SIGTERM');+ });++ it('should keep polling while the ping endpoint returns an error', async () => {+ fetchMock.mockImplementationOnce(() => respond(false)).mockImplementation(() => respond(true));++ const promise = sut.checkApiHealth();+ await vi.advanceTimersByTimeAsync(2000);++ await expect(promise).resolves.toBeUndefined();+ expect(fetchMock).toHaveBeenCalledTimes(2);+ });++ it('should reject when the api worker exits before answering', async () => {+ fetchMock.mockImplementation(refused);++ const promise = sut.checkApiHealth();+ worker.emit('exit', 1, null);++ await expect(promise).rejects.toThrowErrorMatchingInlineSnapshot(+ `[Error: Server health check failed, server exited with 1]`,+ );+ await vi.advanceTimersByTimeAsync(5000);+ expect(fetchMock).not.toHaveBeenCalled();+ });++ it('should reject and stop the api worker when it does not answer in time', async () => {+ fetchMock.mockImplementation(refused);++ const promise = sut.checkApiHealth();+ const assertion = expect(promise).rejects.toThrowErrorMatchingInlineSnapshot(+ `[Error: Server health check failed, took too long to start.]`,+ );+ await vi.advanceTimersByTimeAsync(180_000);++ await assertion;+ expect(worker.kill).toHaveBeenCalledWith('SIGTERM');++ const calls = fetchMock.mock.calls.length;+ await vi.advanceTimersByTimeAsync(5000);+ expect(fetchMock).toHaveBeenCalledTimes(calls);+ });+ });+});diff --git a/server/src/maintenance/maintenance-health.repository.ts b/server/src/maintenance/maintenance-health.repository.tsindex 07e0ad824e..2e386d9423 100644--- a/server/src/maintenance/maintenance-health.repository.ts+++ b/server/src/maintenance/maintenance-health.repository.ts@@ -1,7 +1,11 @@import { Injectable } from '@nestjs/common';import { fork } from 'node:child_process';import { dirname, join } from 'node:path';-import { IMMICH_SERVER_START } from 'src/constants.js';++const HEALTH_CHECK_HOST = '127.0.0.1';+const HEALTH_CHECK_PORT = '33001';+const HEALTH_CHECK_TIMEOUT = 180_000;+const PING_INTERVAL = 1000;@Injectable()export class MaintenanceHealthRepository {@@ -14,42 +18,54 @@ export class MaintenanceHealthRepository {execArgv: process.execArgv.filter((arg) => !arg.startsWith('--inspect')),env: {...process.env,- IMMICH_HOST: '127.0.0.1',- IMMICH_PORT: '33001',+ IMMICH_HOST: HEALTH_CHECK_HOST,+ IMMICH_PORT: HEALTH_CHECK_PORT,},- stdio: ['ignore', 'pipe', 'ignore', 'ipc'],+ stdio: ['ignore', 'ignore', 'ignore', 'ipc'],});- let output = '';+ let settled = false;+ let pingTimer: NodeJS.Timeout | undefined;- worker.stdout?.on('data', (data) => {- if (worker.exitCode !== null) {+ function settle(error?: Error) {+ if (settled) {return;}- output += data;+ settled = true;+ clearTimeout(pingTimer);+ clearTimeout(deadline);+ worker.kill('SIGTERM');- if (!output.includes(IMMICH_SERVER_START)) {- return;+ if (error) {+ reject(error);+ } else {+ resolve();}+ }- resolve();- worker.kill('SIGTERM');- });+ async function ping() {+ const response = await fetch(`http://${HEALTH_CHECK_HOST}:${HEALTH_CHECK_PORT}/api/server/ping`, {+ signal: AbortSignal.timeout(PING_INTERVAL * 5),+ }).catch(() => null);++ if (response?.ok) {+ settle();+ } else if (!settled) {+ pingTimer = setTimeout(() => void ping(), PING_INTERVAL);+ }+ }worker.on('exit', (code, signal) =>- reject(new Error(`Server health check failed, server exited with ${signal ?? code}`)),+ settle(new Error(`Server health check failed, server exited with ${signal ?? code}`)),);- worker.on('error', (error) => reject(new Error(`Server health check failed, process threw: ${error}`)));-- setTimeout(() => {- if (worker.exitCode !== null) {- return;- }+ worker.on('error', (error) => settle(new Error(`Server health check failed, process threw: ${error}`)));- reject(new Error('Server health check failed, took too long to start.'));- worker.kill('SIGTERM');- }, 180_000);+ const deadline = setTimeout(+ () => settle(new Error('Server health check failed, took too long to start.')),+ HEALTH_CHECK_TIMEOUT,+ );+ pingTimer = setTimeout(() => void ping(), PING_INTERVAL);});}}diff --git a/server/src/maintenance/maintenance-worker.service.spec.ts b/server/src/maintenance/maintenance-worker.service.spec.tsindex 9d131be08a..34cb09600d 100644--- a/server/src/maintenance/maintenance-worker.service.spec.ts+++ b/server/src/maintenance/maintenance-worker.service.spec.ts@@ -1,6 +1,6 @@import { UnauthorizedException } from '@nestjs/common';import { SignJWT } from 'jose';-import { MaintenanceAction, SystemMetadataKey } from 'src/enum.js';+import { DatabaseLock, MaintenanceAction, SystemMetadataKey } from 'src/enum.js';import { MaintenanceHealthRepository } from 'src/maintenance/maintenance-health.repository.js';import { MaintenanceWebsocketRepository } from 'src/maintenance/maintenance-websocket.repository.js';import { MaintenanceWorkerService } from 'src/maintenance/maintenance-worker.service.js';@@ -10,12 +10,14 @@ import { AutoMocked, ServiceMocks, automock, getMocks } from 'test/utils.js';describe(MaintenanceWorkerService.name, () => {let sut: MaintenanceWorkerService;let mocks: ServiceMocks;+ let moduleRefMock: { get: ReturnType<typeof vitest.fn> };let maintenanceWebsocketRepositoryMock: AutoMocked<MaintenanceWebsocketRepository>;let maintenanceHealthRepositoryMock: AutoMocked<MaintenanceHealthRepository>;let databaseBackupServiceMock: AutoMocked<DatabaseBackupService>;beforeEach(() => {mocks = getMocks();+ moduleRefMock = { get: vitest.fn() };maintenanceWebsocketRepositoryMock = automock(MaintenanceWebsocketRepository, {args: [mocks.logger],strict: false,@@ -50,6 +52,7 @@ describe(MaintenanceWorkerService.name, () => {mocks.process,mocks.database as never,databaseBackupServiceMock,+ moduleRefMock as never,);sut.mock({@@ -58,6 +61,33 @@ describe(MaintenanceWorkerService.name, () => {});});+ describe('init', () => {+ beforeEach(() => {+ mocks.systemMetadata.get.mockResolvedValue({ isMaintenanceMode: true, secret: 'secret' });+ });++ it('takes the backups SDK lock so its jobs run during maintenance', async () => {+ const futoBackups = { acquireLock: vitest.fn() };+ moduleRefMock.get.mockReturnValue(futoBackups);+ mocks.database.tryLock.mockResolvedValue(true);++ await sut.init();++ expect(mocks.database.tryLock).toHaveBeenCalledWith(DatabaseLock.FutoBackupsModuleConfig);+ expect(futoBackups.acquireLock).toHaveBeenCalled();+ });++ it('leaves the backups SDK lock to whoever already holds it', async () => {+ const futoBackups = { acquireLock: vitest.fn() };+ moduleRefMock.get.mockReturnValue(futoBackups);+ mocks.database.tryLock.mockResolvedValue(false);++ await sut.init();++ expect(futoBackups.acquireLock).not.toHaveBeenCalled();+ });+ });+it('should work', () => {expect(sut).toBeDefined();});diff --git a/server/src/maintenance/maintenance-worker.service.ts b/server/src/maintenance/maintenance-worker.service.tsindex 6e51ac61aa..87f0ca3711 100644--- a/server/src/maintenance/maintenance-worker.service.ts+++ b/server/src/maintenance/maintenance-worker.service.ts@@ -1,9 +1,12 @@+import { YuccaService } from '@futo-org/backups-orchestrator-api';import { Injectable, UnauthorizedException } from '@nestjs/common';+import { ModuleRef } from '@nestjs/core';import { parseCookie } from 'cookie';import { NextFunction, Request, Response } from 'express';import { jwtVerify } from 'jose';import { readFileSync } from 'node:fs';import { IncomingHttpHeaders } from 'node:http';+import { basename } from 'node:path';import type { MaintenanceModeState } from 'src/types.js';import { serverVersion } from 'src/constants.js';import { StorageCore } from 'src/cores/storage.core.js';@@ -32,6 +35,7 @@ import { type VersionService as _VersionService } from 'src/services/version.serimport { getConfig } from 'src/utils/config.js';import { createMaintenanceLoginUrl, detectPriorInstall } from 'src/utils/maintenance.js';import { getExternalDomain } from 'src/utils/misc.js';+import { detectMediaLocation } from 'src/utils/storage.js';/** This service is available inside of maintenance mode to manage maintenance mode */@Injectable()@@ -53,6 +57,7 @@ export class MaintenanceWorkerService {private processRepository: ProcessRepository,private databaseRepository: DatabaseRepository,private databaseBackupService: DatabaseBackupService,+ private moduleRef: ModuleRef,) {this.logger.setContext(this.constructor.name);}@@ -80,6 +85,10 @@ export class MaintenanceWorkerService {await this.logSecret();+ if (await this.databaseRepository.tryLock(DatabaseLock.FutoBackupsModuleConfig)) {+ this.moduleRef.get(YuccaService, { strict: false }).acquireLock();+ }+if (state.action) {void this.runAction(state.action);}@@ -146,28 +155,9 @@ export class MaintenanceWorkerService {};}- /** {@link _StorageService.detectMediaLocation} */detectMediaLocation(): string {const envData = this.configRepository.getEnv();- if (envData.storage.mediaLocation) {- return envData.storage.mediaLocation;- }-- const targets: string[] = [];- const candidates = ['/data', '/usr/src/app/upload'];-- for (const candidate of candidates) {- const isExists = this.storageRepository.existsSync(candidate);- if (isExists) {- targets.push(candidate);- }- }-- if (targets.length === 1) {- return targets[0];- }-- return '/usr/src/app/upload';+ return detectMediaLocation(envData.storage.mediaLocation, (path) => this.storageRepository.existsSync(path));}private get secret() {@@ -277,6 +267,9 @@ export class MaintenanceWorkerService {case MaintenanceAction.RestoreDatabase: {return this.runRestoreDatabase(action);}+ case MaintenanceAction.Rollback: {+ return this.runRollback(action);+ }}}@@ -335,6 +328,67 @@ export class MaintenanceWorkerService {});}+ private async runRollback(action: SetMaintenanceModeDto) {+ const isLock = await this.databaseRepository.tryLock(DatabaseLock.MaintenanceOperation);+ if (!isLock) {+ return;+ }++ this.logger.log(`Running maintenance action ${action.action}`);++ await this.systemMetadataRepository.set(SystemMetadataKey.MaintenanceMode, {+ isMaintenanceMode: true,+ secret: this.secret,+ action: {+ action: MaintenanceAction.Start,+ },+ });++ try {+ if (!action.rollbackRepositoryId || !action.rollbackSnapshotId) {+ throw new Error("Expected rollbackRepositoryId and rollbackSnapshotId but they're missing!");+ }++ await this.rollback(action.rollbackRepositoryId, action.rollbackSnapshotId);+ } catch (error) {+ this.logger.error(`Encountered error running action: ${error}`);+ this.setStatus({+ active: true,+ action: action.action,+ task: 'error',+ error: String(error),+ futoBackupsJobId: this.#status.futoBackupsJobId,+ });+ }+ }++ private async rollback(repositoryId: string, snapshotId: string): Promise<void> {+ this.setStatus({+ active: true,+ action: MaintenanceAction.Rollback,+ });++ const futoBackups = this.moduleRef.get(YuccaService, { strict: false });+ const { jobId, task, immichBackupFileName } = await futoBackups.restoreSnapshotInplace(repositoryId, snapshotId);++ this.setStatus({+ active: true,+ action: MaintenanceAction.Rollback,+ futoBackupsJobId: jobId,+ });++ await task;++ if (!immichBackupFileName) {+ return this.setAction({+ action: MaintenanceAction.SelectDatabaseRestore,+ });+ }++ const backupFileName = basename(immichBackupFileName);+ await this.restoreBackup(backupFileName);+ }+private async endMaintenance(): Promise<void> {const state: MaintenanceModeState = { isMaintenanceMode: false as const };await this.systemMetadataRepository.set(SystemMetadataKey.MaintenanceMode, state);diff --git a/server/src/middleware/auth.guard.spec.ts b/server/src/middleware/auth.guard.spec.tsindex f5d9c90f3e..82453199f4 100644--- a/server/src/middleware/auth.guard.spec.ts+++ b/server/src/middleware/auth.guard.spec.ts@@ -16,9 +16,15 @@ class TestController {undecoratedRoute() {}}-const contextFor = (handler: () => void) =>+@Authenticated({ admin: true })+class AdminTestController {+ route() {}+}++const contextFor = (handler: () => void, controller: object = TestController) =>({getHandler: () => handler,+ getClass: () => controller,switchToHttp: () => ({ getRequest: () => ({ headers: {}, query: {}, path: '/' }) }),}) as unknown as ExecutionContext;@@ -79,4 +85,18 @@ describe(AuthGuard.name, () => {expect(authenticate).not.toHaveBeenCalled();});});++ describe('class-level @Authenticated()', () => {+ it('should apply the controller options to its undecorated routes', async () => {+ const authenticate = vitest.spyOn(authService, 'authenticate').mockResolvedValue({} as never);++ await expect(sut.canActivate(contextFor(AdminTestController.prototype.route, AdminTestController))).resolves.toBe(+ true,+ );++ expect(authenticate).toHaveBeenCalledWith(+ expect.objectContaining({ metadata: expect.objectContaining({ adminRoute: true }) }),+ );+ });+ });});diff --git a/server/src/middleware/auth.guard.ts b/server/src/middleware/auth.guard.tsindex c71655c706..6995d3f673 100644--- a/server/src/middleware/auth.guard.ts+++ b/server/src/middleware/auth.guard.ts@@ -26,12 +26,12 @@ export type AuthenticatedOptions = AuthorizedRoute | PublicRoute;type ReflectorTarget = Parameters<Reflector['get']>[1];/** Resolves the `@Authenticated()` options of a route handler, with the defaults applied. */-export const getAuthenticatedOptions = (reflector: Reflector, target: ReflectorTarget) => {- const options = reflector.getAllAndOverride<AuthenticatedOptions | undefined>(MetadataKey.AuthRoute, [target]);+export const getAuthenticatedOptions = (reflector: Reflector, targets: ReflectorTarget[]) => {+ const options = reflector.getAllAndOverride<AuthenticatedOptions | undefined>(MetadataKey.AuthRoute, targets);return options && { sharedLink: false, admin: false, public: false, setup: false, ...options };};-export const Authenticated = (options: AuthenticatedOptions = {}): MethodDecorator => {+export const Authenticated = (options: AuthenticatedOptions = {}): ReturnType<typeof applyDecorators> => {const decorators: MethodDecorator[] = [SetMetadata(MetadataKey.AuthRoute, options)];if (!options.public) {@@ -97,7 +97,7 @@ export class AuthGuard implements CanActivate {}async canActivate(context: ExecutionContext): Promise<boolean> {- const options = getAuthenticatedOptions(this.reflector, context.getHandler());+ const options = getAuthenticatedOptions(this.reflector, [context.getHandler(), context.getClass()]);if (!options) {throw new Error(`Route ${context.getHandler().name} does not declare @Authenticated()`);}diff --git a/server/src/middleware/websocket.adapter.ts b/server/src/middleware/websocket.adapter.tsindex cedaabc51d..ef83e86720 100644--- a/server/src/middleware/websocket.adapter.ts+++ b/server/src/middleware/websocket.adapter.ts@@ -15,7 +15,11 @@ export class WebSocketAdapter extends IoAdapter {const server = super.createIOServer(port, options);const pubClient = new Redis(redis);const subClient = pubClient.duplicate();- server.adapter(createAdapter(pubClient, subClient));+ const isImmichSocket = !options?.path || options.path === '/api/socket.io';+ const adapterOpts = {+ key: isImmichSocket ? undefined : `socket.io` + options.path,+ };+ server.adapter(createAdapter(pubClient, subClient, adapterOpts));return server;}}diff --git a/server/src/repositories/event.repository.ts b/server/src/repositories/event.repository.tsindex 60a227a183..c1ad5a1f39 100644--- a/server/src/repositories/event.repository.ts+++ b/server/src/repositories/event.repository.ts@@ -71,6 +71,10 @@ type EventMap = {/** job finishes with error */JobError: [JobErrorEvent];+ LibraryCreate: [];+ LibraryUpdate: [];+ LibraryDelete: [];+// queue eventsQueueStart: [QueueStartEvent];diff --git a/server/src/repositories/websocket.repository.ts b/server/src/repositories/websocket.repository.tsindex 5c963d0171..3a0b5aeaf8 100644--- a/server/src/repositories/websocket.repository.ts+++ b/server/src/repositories/websocket.repository.ts@@ -19,6 +19,9 @@ import { handlePromiseError } from 'src/utils/misc.js';export const serverEvents = ['ConfigUpdate','AppRestart',+ 'LibraryCreate',+ 'LibraryUpdate',+ 'LibraryDelete','HlsSegmentRequest','HlsSegmentResult','HlsHeartbeat',diff --git a/server/src/services/database-backup.service.spec.ts b/server/src/services/database-backup.service.spec.tsindex c6869705cb..8a57bbfc7d 100644--- a/server/src/services/database-backup.service.spec.ts+++ b/server/src/services/database-backup.service.spec.ts@@ -217,6 +217,12 @@ describe(DatabaseBackupService.name, () => {`);});+ it('should abort the backup and remove the temporary file when the signal is aborted', async () => {+ await expect(sut.createDatabaseBackup('', AbortSignal.abort())).rejects.toThrow('The operation was aborted');+ expect(mocks.storage.unlink).toHaveBeenCalled();+ expect(mocks.storage.rename).not.toHaveBeenCalled();+ });+it('should run a database backup successfully', async () => {const result = await sut.handleBackupDatabase();expect(result).toBe(JobStatus.Success);diff --git a/server/src/services/database-backup.service.ts b/server/src/services/database-backup.service.tsindex a2d1dbed84..4ad0185ffd 100644--- a/server/src/services/database-backup.service.ts+++ b/server/src/services/database-backup.service.ts@@ -224,7 +224,7 @@ export class DatabaseBackupService {};}- async createDatabaseBackup(filenamePrefix: string = ''): Promise<string> {+ async createDatabaseBackup(filenamePrefix: string = '', signal?: AbortSignal): Promise<string> {this.logger.debug(`Database Backup Started`);const { bin, args, databasePassword, databaseVersion, databaseMajorVersion } =@@ -252,7 +252,7 @@ export class DatabaseBackupService {gzip = this.processRepository.spawnDuplexStream(compression.command, compression.args);const fileStream = this.storageRepository.createWriteStream(temporaryFilePath);- await pipeline(pgdump, gzip, fileStream);+ await pipeline(pgdump, gzip, fileStream, { signal });await this.storageRepository.rename(temporaryFilePath, backupFilePath);} catch (error) {this.logger.error(`Database Backup Failure: ${error}`);diff --git a/server/src/services/futo-backups.service.ts b/server/src/services/futo-backups.service.tsnew file mode 100644index 0000000000..1d2d551d33--- /dev/null+++ b/server/src/services/futo-backups.service.ts@@ -0,0 +1,102 @@+import { type ImmichDatabaseDumpConfig, YuccaService as OrchestratorService } from '@futo-org/backups-orchestrator-api';+import { Injectable, Optional } from '@nestjs/common';+import type { SystemConfig } from 'src/dtos/config.dto.js';+import type { ArgOf } from 'src/repositories/event.repository.js';+import { StorageCore } from 'src/cores/storage.core.js';+import { OnEvent } from 'src/decorators.js';+import { DatabaseLock, ImmichWorker, MaintenanceAction, StorageFolder } from 'src/enum.js';+import { DatabaseRepository } from 'src/repositories/database.repository.js';+import { LibraryRepository } from 'src/repositories/library.repository.js';+import { DatabaseBackupService } from 'src/services/database-backup.service.js';+import { MaintenanceService } from 'src/services/maintenance.service.js';+import { SystemConfigService } from 'src/services/system-config.service.js';+import { getExternalDomain } from 'src/utils/misc.js';++@Injectable()+export class FutoBackupsService {+ constructor(+ private readonly databaseRepository: DatabaseRepository,+ private readonly libraryRepository: LibraryRepository,+ private readonly databaseBackupService: DatabaseBackupService,+ private readonly systemConfigService: SystemConfigService,+ @Optional() private readonly maintenanceService: MaintenanceService,+ @Optional() private readonly orchestratorService: OrchestratorService,+ ) {}++ private updateSystemConfig({ server }: SystemConfig) {+ this.orchestratorService.setExternalBaseUrl(getExternalDomain(server));+ }++ private async updateLibraryConfig() {+ const libraries = await this.libraryRepository.getAll();++ this.orchestratorService.setImmichIntegration({+ dataPath: StorageCore.getMediaLocation(),+ dataFolders: Object.values(StorageFolder),+ libraries: libraries+ .filter((library) => !library.deletedAt)+ .map(({ id, name, importPaths, exclusionPatterns }) => ({ id, name, importPaths, exclusionPatterns })),+ hooks: {+ createDatabaseBackup: (signal) => this.databaseBackupService.createDatabaseBackup('', signal),+ cleanupDatabaseBackups: () => this.databaseBackupService.cleanupDatabaseBackups(),+ getImmichDatabaseDumpConfig: () => this.getImmichDatabaseDumpConfig(),+ configureImmichDatabaseDump: (databaseDump) => this.configureImmichDatabaseDump(databaseDump),+ enterMaintenanceRollback: (repositoryId, snapshotId) => this.enterMaintenanceRollback(repositoryId, snapshotId),+ },+ });+ }++ private async getImmichDatabaseDumpConfig(): Promise<ImmichDatabaseDumpConfig> {+ const { backup } = await this.systemConfigService.getAdminConfig();+ return { enabled: backup.database.enabled, keepLastAmount: backup.database.keepLastAmount };+ }++ private async configureImmichDatabaseDump(databaseDump: Partial<ImmichDatabaseDumpConfig>) {+ const config = await this.systemConfigService.getAdminConfig();+ await this.systemConfigService.updateAdminConfig({+ ...config,+ backup: { ...config.backup, database: { ...config.backup.database, ...databaseDump } },+ });+ }++ private enterMaintenanceRollback(repositoryId: string, snapshotId: string) {+ return this.maintenanceService.startMaintenance(+ {+ action: MaintenanceAction.Rollback,+ rollbackRepositoryId: repositoryId,+ rollbackSnapshotId: snapshotId,+ },+ 'futo-backups-rollback',+ );+ }++ @OnEvent({ name: 'ConfigInit', workers: [ImmichWorker.Api] })+ async onConfigInit({ newConfig }: ArgOf<'ConfigInit'>) {+ this.updateSystemConfig(newConfig);+ void this.updateLibraryConfig();++ if (await this.databaseRepository.tryLock(DatabaseLock.FutoBackupsModuleConfig)) {+ this.orchestratorService.acquireLock();+ }+ }++ @OnEvent({ name: 'ConfigUpdate', workers: [ImmichWorker.Api], server: true })+ onConfigUpdate({ newConfig }: ArgOf<'ConfigUpdate'>) {+ this.updateSystemConfig(newConfig);+ }++ @OnEvent({ name: 'LibraryCreate', workers: [ImmichWorker.Api], server: true })+ onLibraryCreate() {+ void this.updateLibraryConfig();+ }++ @OnEvent({ name: 'LibraryUpdate', workers: [ImmichWorker.Api], server: true })+ onLibraryUpdate() {+ void this.updateLibraryConfig();+ }++ @OnEvent({ name: 'LibraryDelete', workers: [ImmichWorker.Api], server: true })+ onLibraryDelete() {+ void this.updateLibraryConfig();+ }+}diff --git a/server/src/services/index.ts b/server/src/services/index.tsindex a491c6722d..0599fa4c51 100644--- a/server/src/services/index.ts+++ b/server/src/services/index.ts@@ -13,6 +13,7 @@ import { DatabaseBackupService } from 'src/services/database-backup.service.js';import { DatabaseService } from 'src/services/database.service.js';import { DownloadService } from 'src/services/download.service.js';import { DuplicateService } from 'src/services/duplicate.service.js';+import { FutoBackupsService } from 'src/services/futo-backups.service.js';import { HlsService } from 'src/services/hls.service.js';import { IntegrityService } from 'src/services/integrity.service.js';import { JobService } from 'src/services/job.service.js';@@ -68,6 +69,7 @@ export const services = [DatabaseService,DownloadService,DuplicateService,+ FutoBackupsService,IntegrityService,HlsService,JobService,diff --git a/server/src/services/library.service.spec.ts b/server/src/services/library.service.spec.tsindex 2c281c7307..19ff96c456 100644--- a/server/src/services/library.service.spec.ts+++ b/server/src/services/library.service.spec.ts@@ -620,6 +620,7 @@ describe(LibraryService.name, () => {expect(mocks.job.queue).toHaveBeenCalledWith({ name: JobName.LibraryDelete, data: { id: library.id } });expect(mocks.library.softDelete).toHaveBeenCalledWith(library.id);+ expect(mocks.event.emit).toHaveBeenCalledWith('LibraryDelete');});it('should allow an external library to be deleted', async () => {@@ -725,6 +726,7 @@ describe(LibraryService.name, () => {exclusionPatterns: expect.any(Array),}),);+ expect(mocks.event.emit).toHaveBeenCalledWith('LibraryCreate');});it('should create with name', async () => {@@ -892,6 +894,7 @@ describe(LibraryService.name, () => {'library-id',expect.objectContaining({ importPaths: [`${cwd}/foo/bar`] }),);+ expect(mocks.event.emit).toHaveBeenCalledWith('LibraryUpdate');});});diff --git a/server/src/services/library.service.ts b/server/src/services/library.service.tsindex 7fac6db3f9..e91eca69ae 100644--- a/server/src/services/library.service.ts+++ b/server/src/services/library.service.ts@@ -247,6 +247,8 @@ export class LibraryService extends BaseService {'**/.stfolder/**',],});++ await this.eventRepository.emit('LibraryCreate');return mapLibrary(library);}@@ -358,6 +360,7 @@ export class LibraryService extends BaseService {}const library = await this.libraryRepository.update(id, dto);+ await this.eventRepository.emit('LibraryUpdate');return mapLibrary(library);}@@ -370,6 +373,8 @@ export class LibraryService extends BaseService {await this.libraryRepository.softDelete(id);await this.jobRepository.queue({ name: JobName.LibraryDelete, data: { id } });++ await this.eventRepository.emit('LibraryDelete');}@OnJob({ name: JobName.LibraryDelete, queue: QueueName.Library })diff --git a/server/src/services/notification.service.spec.ts b/server/src/services/notification.service.spec.tsindex 03193d1b8c..971add822b 100644--- a/server/src/services/notification.service.spec.ts+++ b/server/src/services/notification.service.spec.ts@@ -70,6 +70,27 @@ describe(NotificationService.name, () => {});});+ describe('onLibraryCreate', () => {+ it('should relay the event to other servers', () => {+ sut.onLibraryCreate();+ expect(mocks.websocket.serverSend).toHaveBeenCalledWith('LibraryCreate');+ });+ });++ describe('onLibraryUpdate', () => {+ it('should relay the event to other servers', () => {+ sut.onLibraryUpdate();+ expect(mocks.websocket.serverSend).toHaveBeenCalledWith('LibraryUpdate');+ });+ });++ describe('onLibraryDelete', () => {+ it('should relay the event to other servers', () => {+ sut.onLibraryDelete();+ expect(mocks.websocket.serverSend).toHaveBeenCalledWith('LibraryDelete');+ });+ });+describe('onConfigValidateEvent', () => {it('validates smtp config when enabling smtp', async () => {const oldConfig = configs.smtpDisabled;diff --git a/server/src/services/notification.service.ts b/server/src/services/notification.service.tsindex 24a6c7024d..0f491e100a 100644--- a/server/src/services/notification.service.ts+++ b/server/src/services/notification.service.ts@@ -123,6 +123,21 @@ export class NotificationService extends BaseService {this.websocketRepository.serverSend('AppRestart', state);}+ @OnEvent({ name: 'LibraryCreate' })+ onLibraryCreate() {+ this.websocketRepository.serverSend('LibraryCreate');+ }++ @OnEvent({ name: 'LibraryUpdate' })+ onLibraryUpdate() {+ this.websocketRepository.serverSend('LibraryUpdate');+ }++ @OnEvent({ name: 'LibraryDelete' })+ onLibraryDelete() {+ this.websocketRepository.serverSend('LibraryDelete');+ }+@OnEvent({ name: 'ConfigValidate', priority: -100 })async onConfigValidate({ oldConfig, newConfig }: ArgOf<'ConfigValidate'>) {try {diff --git a/server/src/services/server.service.spec.ts b/server/src/services/server.service.spec.tsindex 00a6653dd8..6174e994bf 100644--- a/server/src/services/server.service.spec.ts+++ b/server/src/services/server.service.spec.ts@@ -138,6 +138,7 @@ describe(ServerService.name, () => {duplicateDetection: true,facialRecognition: true,importFaces: false,+ backups: false,map: true,reverseGeocoding: true,oauth: false,diff --git a/server/src/services/server.service.ts b/server/src/services/server.service.tsindex b0e6ce81f0..bf5e323eb2 100644--- a/server/src/services/server.service.ts+++ b/server/src/services/server.service.ts@@ -86,8 +86,18 @@ export class ServerService extends BaseService {}async getFeatures(): Promise<ServerFeaturesDto> {- const { reverseGeocoding, metadata, map, machineLearning, trash, oauth, passwordLogin, notifications, ffmpeg } =- await this.getConfig({ withCache: false });+ const {+ reverseGeocoding,+ metadata,+ map,+ backup,+ machineLearning,+ trash,+ oauth,+ passwordLogin,+ notifications,+ ffmpeg,+ } = await this.getConfig({ withCache: false });const { configFile } = this.configRepository.getEnv();return {@@ -95,6 +105,7 @@ export class ServerService extends BaseService {facialRecognition: isFacialRecognitionEnabled(machineLearning),duplicateDetection: isDuplicateDetectionEnabled(machineLearning),map: map.enabled,+ backups: !!backup.beta,reverseGeocoding: reverseGeocoding.enabled,importFaces: metadata.faces.import,sidecar: true,diff --git a/server/src/services/storage.service.ts b/server/src/services/storage.service.tsindex 9ac44e6f11..21df95d0a3 100644--- a/server/src/services/storage.service.ts+++ b/server/src/services/storage.service.ts@@ -15,6 +15,7 @@ import {} from 'src/enum.js';import { BaseService } from 'src/services/base.service.js';import { ImmichStartupError } from 'src/utils/misc.js';+import { detectMediaLocation } from 'src/utils/storage.js';const docsMessage = `Please see https://docs.immich.app/administration/system-integrity#folder-checks for more information.`;@@ -22,25 +23,7 @@ const docsMessage = `Please see https://docs.immich.app/administration/system-inexport class StorageService extends BaseService {private detectMediaLocation(): string {const envData = this.configRepository.getEnv();- if (envData.storage.mediaLocation) {- return envData.storage.mediaLocation;- }-- const targets: string[] = [];- const candidates = ['/data', '/usr/src/app/upload'];-- for (const candidate of candidates) {- const isExists = this.storageRepository.existsSync(candidate);- if (isExists) {- targets.push(candidate);- }- }-- if (targets.length === 1) {- return targets[0];- }-- return '/usr/src/app/upload';+ return detectMediaLocation(envData.storage.mediaLocation, (path) => this.storageRepository.existsSync(path));}@OnEvent({ name: 'AppBootstrap', priority: BootstrapEventPriority.StorageService })diff --git a/server/src/services/system-config.service.spec.ts b/server/src/services/system-config.service.spec.tsindex 0f7e297f1e..7968c64769 100644--- a/server/src/services/system-config.service.spec.ts+++ b/server/src/services/system-config.service.spec.ts@@ -47,6 +47,7 @@ const updatedConfig = Object.freeze<SystemConfig>({[QueueName.Editor]: { concurrency: 2 },},backup: {+ beta: false,database: {enabled: true,cronExpression: '0 02 * * *',diff --git a/server/src/utils/storage.ts b/server/src/utils/storage.tsnew file mode 100644index 0000000000..7485dac351--- /dev/null+++ b/server/src/utils/storage.ts@@ -0,0 +1,49 @@+import { existsSync } from 'node:fs';+import { join } from 'node:path';++const MEDIA_LOCATION_CANDIDATES = ['/data', '/usr/src/app/upload'];+const MEDIA_LOCATION_FALLBACK = '/usr/src/app/upload';++export const detectMediaLocation = (mediaLocation: string | undefined, exists: (path: string) => boolean): string => {+ if (mediaLocation) {+ return mediaLocation;+ }++ const targets: string[] = [];++ for (const candidate of MEDIA_LOCATION_CANDIDATES) {+ if (exists(candidate)) {+ targets.push(candidate);+ }+ }++ if (targets.length === 1) {+ return targets[0];+ }++ return MEDIA_LOCATION_FALLBACK;+};++export const getBackupsStatePath = (mediaLocation: string | undefined): string => {+ if (mediaLocation) {+ return join(mediaLocation, 'backups', 'yucca');+ }++ const candidates = MEDIA_LOCATION_CANDIDATES.filter((candidate) => existsSync(candidate));++ let warning: string | undefined;+ if (candidates.length === 0) {+ warning = `None of ${MEDIA_LOCATION_CANDIDATES.join(', ')} exist and media location is not otherwise set`;+ } else if (candidates.length > 1) {+ warning = `Multiple paths (${candidates.join(', ')}) exist at the same time`;+ }++ const statePath = join(candidates.length === 1 ? candidates[0] : MEDIA_LOCATION_FALLBACK, 'backups', 'yucca');+ if (warning) {+ console.warn(+ `${warning}, your backup configuration and encryption keys will be read from ${statePath}, which may not be where they were originally written.`,+ );+ }++ return statePath;+};diff --git a/server/src/workers/api.ts b/server/src/workers/api.tsindex 0165a2c6e5..101e444f4b 100644--- a/server/src/workers/api.ts+++ b/server/src/workers/api.ts@@ -13,6 +13,10 @@ async function bootstrap() {const app = await NestFactory.create<NestExpressApplication>(ApiModule, {bufferLogs: true,+ // default module id algorithm can cause+ // the ApiModule to be instatiated more than+ // once when injected into OrchestrationApiModule+ moduleIdGeneratorAlgorithm: 'deep-hash',routeConflictPolicy: { duplicate: 'error' },routeResolutionStrategy: 'specificity',});diff --git a/server/src/workers/maintenance.ts b/server/src/workers/maintenance.tsindex 822e56e212..e451096284 100644--- a/server/src/workers/maintenance.ts+++ b/server/src/workers/maintenance.ts@@ -12,6 +12,8 @@ async function bootstrap() {const app = await NestFactory.create<NestExpressApplication>(MaintenanceModule, {bufferLogs: true,+ // see comment in api.ts+ moduleIdGeneratorAlgorithm: 'deep-hash',routeConflictPolicy: { duplicate: 'error' },routeResolutionStrategy: 'specificity',});diff --git a/server/test/medium/specs/services/library.service.spec.ts b/server/test/medium/specs/services/library.service.spec.tsindex 8f69f8b225..cd0f7d0756 100644--- a/server/test/medium/specs/services/library.service.spec.ts+++ b/server/test/medium/specs/services/library.service.spec.ts@@ -16,6 +16,7 @@ import { JobRepository } from 'src/repositories/job.repository.js';import { LibraryRepository } from 'src/repositories/library.repository.js';import { LoggingRepository } from 'src/repositories/logging.repository.js';import { StorageRepository } from 'src/repositories/storage.repository.js';+import { WebsocketRepository } from 'src/repositories/websocket.repository.js';import { DB } from 'src/schema/index.js';import { LibraryService } from 'src/services/library.service.js';import { MetadataService } from 'src/services/metadata.service.js';@@ -45,7 +46,14 @@ class LibraryTestContext extends MediumTestContext<typeof LibraryService> {super(LibraryService, {database,real: [AssetRepository, AssetJobRepository, CryptoRepository, LibraryRepository, StorageRepository],- mock: [CronRepository, DatabaseRepository, EventRepository, JobRepository, LoggingRepository],+ mock: [+ CronRepository,+ DatabaseRepository,+ EventRepository,+ JobRepository,+ LoggingRepository,+ WebsocketRepository,+ ],});const jobs = this.getMock(JobRepository);@@ -53,6 +61,7 @@ class LibraryTestContext extends MediumTestContext<typeof LibraryService> {jobs.queueAll.mockResolvedValue();this.getMock(EventRepository).emit.mockResolvedValue();+ this.getMock(WebsocketRepository).serverSend.mockReturnValue();this.metadataService = newMediumService(MetadataService, {database,diff --git a/web/package.json b/web/package.jsonindex de4e9164df..dc35196200 100644--- a/web/package.json+++ b/web/package.json@@ -33,6 +33,7 @@},"dependencies": {"@formatjs/icu-messageformat-parser": "^3.0.0",+ "@futo-org/backups-orchestrator-ui": "1.11.5","@immich/justified-layout-wasm": "^0.4.3","@immich/sdk": "workspace:*","@immich/ui": "^0.91.0",diff --git a/web/src/lib/components/backups/HideBackupsReminder.svelte b/web/src/lib/components/backups/HideBackupsReminder.sveltenew file mode 100644index 0000000000..72f3c80876--- /dev/null+++ b/web/src/lib/components/backups/HideBackupsReminder.svelte@@ -0,0 +1,9 @@+<script lang="ts">+ import { hideBackupsReminder } from '#lib/stores/preferences.store.ts';+ import { Field, Switch } from '@immich/ui';+ import { t } from 'svelte-i18n';+</script>++<Field label={$t('admin.backups_hide_reminder')} description={$t('admin.backups_hide_reminder_description')}>+ <Switch bind:checked={$hideBackupsReminder} />+</Field>diff --git a/web/src/lib/components/layouts/AdminPageLayout.svelte b/web/src/lib/components/layouts/AdminPageLayout.svelteindex 03fa0d5fce..013f017c28 100644--- a/web/src/lib/components/layouts/AdminPageLayout.svelte+++ b/web/src/lib/components/layouts/AdminPageLayout.svelte@@ -2,9 +2,11 @@import BreadcrumbActionPage from '#lib/components/BreadcrumbActionPage.svelte';import NavigationBar from '#lib/components/shared-components/navigation-bar/NavigationBar.svelte';import BottomInfo from '#lib/components/shared-components/side-bar/BottomInfo.svelte';+ import { featureFlagsManager } from '#lib/managers/feature-flags-manager.svelte.ts';import { Route } from '#lib/route.ts';import { sidebarStore } from '#lib/stores/sidebar.svelte.ts';import type { HeaderButtonActionItem } from '#lib/types.ts';+ import { ImmichBackupsAdminNavButton } from '@futo-org/backups-orchestrator-ui';import { AppShell, AppShellHeader, AppShellSidebar, MenuItemType, NavbarItem, type BreadcrumbItem } from '@immich/ui';import { mdiAccountMultipleOutline, mdiBookshelf, mdiCog, mdiServer, mdiTrayFull, mdiWrench } from '@mdi/js';import type { Snippet } from 'svelte';@@ -28,6 +30,10 @@class="flex h-full flex-col justify-between gap-2 border-none shadow-none"><div class="flex flex-col gap-1 pe-4 pt-8">+ {#if featureFlagsManager.value.backups}+ <ImmichBackupsAdminNavButton href={Route.backups()} />+ {/if}+<NavbarItem title={$t('users')} href={Route.users()} icon={mdiAccountMultipleOutline} /><NavbarItem title={$t('external_libraries')} href={Route.libraries()} icon={mdiBookshelf} /><NavbarItem title={$t('admin.queues')} href={Route.queues()} icon={mdiTrayFull} />diff --git a/web/src/lib/components/maintenance/MaintenanceBackupCard.svelte b/web/src/lib/components/maintenance/MaintenanceBackupCard.sveltenew file mode 100644index 0000000000..dce003242d--- /dev/null+++ b/web/src/lib/components/maintenance/MaintenanceBackupCard.svelte@@ -0,0 +1,114 @@+<script lang="ts">+ import { BackupFileStatus } from '#lib/constants.ts';+ import { getDatabaseBackupDateTime } from '#lib/services/database-backups.service.ts';+ import { locale } from '#lib/stores/preferences.store.ts';+ import { getBytesWithUnit } from '#lib/utils/byte-units.ts';+ import { Card, CardBody, Code, HStack, Icon, Stack, Text } from '@immich/ui';+ import { mdiAlertCircle, mdiCheckCircle, mdiDatabaseRefreshOutline } from '@mdi/js';+ import { DateTime } from 'luxon';+ import type { Snippet } from 'svelte';+ import { t } from 'svelte-i18n';++ type Props = {+ filename: string;+ filesize: number;+ expectedVersion: string;+ timezone?: string;+ showFullDate?: boolean;+ class?: string;+ actions?: Snippet;+ };++ const {+ filename,+ filesize,+ expectedVersion,+ timezone,+ showFullDate = false,+ class: className = '',+ actions,+ }: Props = $props();++ const filesizeText = $derived(getBytesWithUnit(filesize, 1));++ const backupDateTime = $derived(getDatabaseBackupDateTime(filename, timezone)?.toLocal());++ const dateDisplay = $derived(+ backupDateTime?.toLocaleString(showFullDate ? DateTime.DATETIME_MED : DateTime.TIME_SIMPLE),+ );+ const relativeTime = $derived(backupDateTime?.toRelative({ locale: $locale }));++ const version = $derived(filename.match(/-v(.*)-/)?.[1]);++ const status = $derived.by(() => {+ if (!version) {+ return BackupFileStatus.UnknownVersion;+ }+ if (version !== expectedVersion) {+ return BackupFileStatus.DifferentVersion;+ }+ return BackupFileStatus.OK;+ });+</script>++<Card class="dark:bg-dark-900 {className}">+ <CardBody class="px-6 pt-3 pb-4">+ <Stack gap={3} class="min-w-0 grow">+ <div class={actions ? 'flex items-center justify-between gap-3' : ''}>+ <HStack gap={2} class="min-w-0">+ {#if status === BackupFileStatus.OK}+ <Icon icon={mdiCheckCircle} size="18" class="text-success" />+ {:else if status === BackupFileStatus.DifferentVersion}+ <Icon icon={mdiAlertCircle} size="18" class="text-warning" />+ {:else}+ <Icon icon={mdiAlertCircle} size="18" class="text-danger" />+ {/if}++ {#if dateDisplay}+ <Text class="font-medium" size="small">{dateDisplay}</Text>+ {:else}+ <Text class="font-medium" size="small">{$t('unknown_date')}</Text>+ {/if}+ {#if relativeTime}+ <div class="flex items-center gap-2">+ <div class="size-1 bg-light-500"></div>+ <Text size="tiny" color="muted">{relativeTime}</Text>+ </div>+ {/if}+ </HStack>++ {#if actions}+ <HStack gap={1}>+ {@render actions()}+ </HStack>+ {/if}+ </div>++ <HStack>+ <Icon icon={mdiDatabaseRefreshOutline} size="16" color="gray" />+ <Code size="small" class="break-all">{filename}</Code>+ </HStack>++ {#if status === BackupFileStatus.UnknownVersion}+ <Text size="small" color="danger">+ {$t('admin.maintenance_restore_backup_unknown_version')}+ </Text>+ {:else if status === BackupFileStatus.DifferentVersion}+ <Text size="small" color="warning">+ {$t('admin.maintenance_restore_backup_different_version')}+ </Text>+ {/if}++ <HStack gap={8}>+ <div class="flex gap-1">+ <Text size="tiny" color="muted">{$t('version')}:</Text>+ <Text size="tiny" fontWeight="medium">{version ? `v${version}` : $t('unknown')}</Text>+ </div>+ <div class="flex gap-1">+ <Text size="tiny" color="muted">{$t('size')}:</Text>+ <Text size="tiny" fontWeight="medium">{filesizeText[0]} {filesizeText[1]}</Text>+ </div>+ </HStack>+ </Stack>+ </CardBody>+</Card>diff --git a/web/src/lib/components/maintenance/MaintenanceBackupEntry.spec.ts b/web/src/lib/components/maintenance/MaintenanceBackupEntry.spec.tsindex af612c9e56..af2806ed0b 100644--- a/web/src/lib/components/maintenance/MaintenanceBackupEntry.spec.ts+++ b/web/src/lib/components/maintenance/MaintenanceBackupEntry.spec.ts@@ -5,13 +5,18 @@ import { DateTime } from 'luxon';import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';import MaintenanceBackupEntry from './MaintenanceBackupEntry.svelte';-vi.mock('#lib/services/database-backups.service.js', () => ({- getDatabaseBackupActions: () => ({- Download: { type: 'command', title: 'Download', onAction: vi.fn() },- Delete: { type: 'command', title: 'Delete', onAction: vi.fn() },- }),- handleRestoreDatabaseBackup: vi.fn(),-}));+vi.mock('#lib/services/database-backups.service.js', async (importOriginal) => {+ const original = await importOriginal<typeof import('#lib/services/database-backups.service.ts')>();++ return {+ ...original,+ getDatabaseBackupActions: () => ({+ Download: { type: 'command', title: 'Download', onAction: vi.fn() },+ Delete: { type: 'command', title: 'Delete', onAction: vi.fn() },+ }),+ handleRestoreDatabaseBackup: vi.fn(),+ };+});describe('MaintenanceBackupEntry', () => {beforeEach(() => {diff --git a/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte b/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelteindex 71e148214a..6e7330223d 100644--- a/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte+++ b/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte@@ -1,12 +1,8 @@<script lang="ts">+ import MaintenanceBackupCard from '#lib/components/maintenance/MaintenanceBackupCard.svelte';import OnEvents from '#lib/components/OnEvents.svelte';- import { BackupFileStatus } from '#lib/constants.ts';import { getDatabaseBackupActions, handleRestoreDatabaseBackup } from '#lib/services/database-backups.service.ts';- import { locale } from '#lib/stores/preferences.store.ts';- import { getBytesWithUnit } from '#lib/utils/byte-units.ts';- import { Button, Card, CardBody, ContextMenuButton, HStack, Icon, Stack, Text } from '@immich/ui';- import { mdiAlertCircle, mdiCheckCircle, mdiDatabaseRefreshOutline } from '@mdi/js';- import { DateTime } from 'luxon';+ import { Button, ContextMenuButton } from '@immich/ui';import { t } from 'svelte-i18n';type Props = {@@ -18,31 +14,6 @@const { filename, filesize, expectedVersion, timezone }: Props = $props();- const filesizeText = $derived(getBytesWithUnit(filesize, 1));-- const backupDateTime = $derived.by(() => {- const dateMatch = filename.match(/\d+T\d+/);- if (dateMatch) {- return DateTime.fromFormat(dateMatch[0], "yyyyMMdd'T'HHmmss", { zone: timezone }).toLocal();- }- return null;- });-- const timeDisplay = $derived(backupDateTime?.toLocaleString(DateTime.TIME_SIMPLE));- const relativeTime = $derived(backupDateTime?.toRelative({ locale: $locale }));-- const version = $derived(filename.match(/-v(.*)-/)?.[1]);-- const status = $derived.by(() => {- if (!version) {- return BackupFileStatus.UnknownVersion;- }- if (version !== expectedVersion) {- return BackupFileStatus.DifferentVersion;- }- return BackupFileStatus.OK;- });-const { Download, Delete } = $derived(getDatabaseBackupActions($t, filename));let isDeleting = $state(false);@@ -56,71 +27,11 @@<OnEvents {onBackupDeleteStatus} />-<Card class="dark:bg-dark-900">- <CardBody class="px-6 pt-3 pb-4">- <Stack gap={3} class="min-w-0 grow">- <div class="flex items-center justify-between gap-3">- <HStack gap={2} class="min-w-0">- {#if status === BackupFileStatus.OK}- <Icon icon={mdiCheckCircle} size="18" class="text-success" />- {:else if status === BackupFileStatus.DifferentVersion}- <Icon icon={mdiAlertCircle} size="18" class="text-warning" />- {:else}- <Icon icon={mdiAlertCircle} size="18" class="text-danger" />- {/if}-- {#if timeDisplay}- <Text class="font-medium" size="small">{timeDisplay}</Text>- {:else}- <Text class="font-medium" size="small">{$t('unknown_date')}</Text>- {/if}- {#if relativeTime}- <div class="flex items-center gap-2">- <div class="size-1 bg-light-500"></div>- <Text size="tiny" color="muted">{relativeTime}</Text>- </div>- {/if}- </HStack>-- <HStack gap={1}>- <Button size="small" onclick={() => handleRestoreDatabaseBackup(filename)} disabled={isDeleting}- >{$t('restore')}</Button- >- <ContextMenuButton- disabled={isDeleting}- position="top-right"- aria-label={$t('open')}- items={[Download, Delete]}- />- </HStack>- </div>-- <HStack>- <Icon icon={mdiDatabaseRefreshOutline} size="16" color="gray" />- <Text size="small" class="font-mono break-all">{filename}</Text>- </HStack>-- {#if status === BackupFileStatus.UnknownVersion}- <Text size="small" color="danger">- {$t('admin.maintenance_restore_backup_unknown_version')}- </Text>- {:else if status === BackupFileStatus.DifferentVersion}- <Text size="small" color="warning">- {$t('admin.maintenance_restore_backup_different_version')}- </Text>- {/if}-- <HStack gap={8}>- <div class="flex gap-1">- <Text size="tiny" color="muted">{$t('version')}:</Text>- <Text size="tiny" fontWeight="medium">{version ? `v${version}` : $t('unknown')}</Text>- </div>-- <div class="flex gap-1">- <Text size="tiny" color="muted">{$t('size')}:</Text>- <Text size="tiny" fontWeight="medium">{filesizeText[0]} {filesizeText[1]}</Text>- </div>- </HStack>- </Stack>- </CardBody>-</Card>+<MaintenanceBackupCard {filename} {filesize} {expectedVersion} {timezone}>+ {#snippet actions()}+ <Button size="small" onclick={() => handleRestoreDatabaseBackup(filename)} disabled={isDeleting}>+ {$t('restore')}+ </Button>+ <ContextMenuButton disabled={isDeleting} position="top-right" aria-label={$t('open')} items={[Download, Delete]} />+ {/snippet}+</MaintenanceBackupCard>diff --git a/web/src/lib/components/maintenance/MaintenanceBackupsList.svelte b/web/src/lib/components/maintenance/MaintenanceBackupsList.svelteindex 30a9ac9fec..f2dab0a975 100644--- a/web/src/lib/components/maintenance/MaintenanceBackupsList.svelte+++ b/web/src/lib/components/maintenance/MaintenanceBackupsList.svelte@@ -2,7 +2,7 @@import HeaderActionButton from '#lib/components/HeaderActionButton.svelte';import MaintenanceBackupEntry from '#lib/components/maintenance/MaintenanceBackupEntry.svelte';import OnEvents from '#lib/components/OnEvents.svelte';- import { handleUploadDatabaseBackup } from '#lib/services/database-backups.service.ts';+ import { getDatabaseBackupDateTime, handleUploadDatabaseBackup } from '#lib/services/database-backups.service.ts';import type { DatabaseBackupDto } from '@immich/sdk';import { listDatabaseBackups } from '@immich/sdk';import { Card, CardBody, HStack, Icon, ProgressBar, Stack, Text } from '@immich/ui';@@ -51,13 +51,12 @@const unknownDateKey = $t('unknown_date');for (const backup of backups) {- const timezone = backup.timezone;- const dateMatch = backup.filename.match(/\d+T\d+/);+ const backupDateTime = getDatabaseBackupDateTime(backup.filename, backup.timezone);let dateKey: string;let dt: DateTime;- if (dateMatch) {- dt = DateTime.fromFormat(dateMatch[0], "yyyyMMdd'T'HHmmss", { zone: timezone });+ if (backupDateTime) {+ dt = backupDateTime;dateKey = dt.toFormat('LLLL d, yyyy');} else {dt = DateTime.fromMillis(0);diff --git a/web/src/lib/components/shared-components/purchasing/PurchaseContent.svelte b/web/src/lib/components/shared-components/purchasing/PurchaseContent.svelteindex 4c11c05714..2f596e7f08 100644--- a/web/src/lib/components/shared-components/purchasing/PurchaseContent.svelte+++ b/web/src/lib/components/shared-components/purchasing/PurchaseContent.svelte@@ -2,7 +2,7 @@import { authManager } from '#lib/managers/auth-manager.svelte.ts';import { handleError } from '#lib/utils/handle-error.ts';import { activateProduct, getActivationKey } from '#lib/utils/license-utils.ts';- import { Button, Heading, LoadingSpinner } from '@immich/ui';+ import { Button, Heading, LoadingSpinner, Text } from '@immich/ui';import { t } from 'svelte-i18n';import UserPurchaseOptionCard from './IndividualPurchaseOptionCard.svelte';import ServerPurchaseOptionCard from './ServerPurchaseOptionCard.svelte';@@ -42,6 +42,9 @@</Heading>{/if}+ <Text>{$t('purchase_product_key_description')}</Text>+ <Text fontWeight="bold">{$t('purchase_product_key_excludes_backups')}</Text>+{#if showMessage}<div class="mt-2"><p>diff --git a/web/src/lib/components/shared-components/side-bar/BottomInfo.svelte b/web/src/lib/components/shared-components/side-bar/BottomInfo.svelteindex 6d966e21a6..00c7acea2f 100644--- a/web/src/lib/components/shared-components/side-bar/BottomInfo.svelte+++ b/web/src/lib/components/shared-components/side-bar/BottomInfo.svelte@@ -1,11 +1,20 @@<script lang="ts">+ import { ImmichBackupsSidebarItem } from '@futo-org/backups-orchestrator-ui';+ import { authManager } from '#lib/managers/auth-manager.svelte.ts';+ import { featureFlagsManager } from '#lib/managers/feature-flags-manager.svelte.ts';import PurchaseInfo from './PurchaseInfo.svelte';import ServerStatus from './ServerStatus.svelte';import StorageSpace from './StorageSpace.svelte';+ import { Route } from '#lib/route.ts';+ import { hideBackupsReminder } from '#lib/stores/preferences.store.ts';</script>-<div class="mt-auto">+<div class="ms-4 mt-auto overflow-hidden rounded-lg"><StorageSpace />++ {#if authManager.user.isAdmin && featureFlagsManager.value.backups && !$hideBackupsReminder}+ <ImmichBackupsSidebarItem href={Route.backups()} />+ {/if}</div><PurchaseInfo />diff --git a/web/src/lib/components/shared-components/side-bar/StorageSpace.svelte b/web/src/lib/components/shared-components/side-bar/StorageSpace.svelteindex 11af323d22..fdff7f8a69 100644--- a/web/src/lib/components/shared-components/side-bar/StorageSpace.svelte+++ b/web/src/lib/components/shared-components/side-bar/StorageSpace.svelte@@ -25,7 +25,7 @@</script><div- class="ms-4 min-w-52 rounded-lg bg-light-100 p-4 text-sm"+ class="min-w-52 bg-light-100 p-4 text-sm"title={$t('storage_usage', {values: {used: getByteUnitString(usedBytes, $locale, 3),diff --git a/web/src/lib/managers/language-manager.svelte.ts b/web/src/lib/managers/language-manager.svelte.tsindex 8fa7fc375a..7a13cf9fa3 100644--- a/web/src/lib/managers/language-manager.svelte.ts+++ b/web/src/lib/managers/language-manager.svelte.ts@@ -1,6 +1,7 @@import { eventManager } from '#lib/managers/event-manager.svelte.ts';import { lang } from '#lib/stores/preferences.store.ts';-import { langs } from '#lib/utils/i18n.ts';+import { convertBCP47, langs } from '#lib/utils/i18n.ts';+import { setYuccaLanguage } from '@futo-org/backups-orchestrator-ui';class LanguageManager {constructor() {@@ -17,10 +18,12 @@ class LanguageManager {return;}this.initialized = true;- lang.subscribe((lang) => this.setLanguage(lang));+ lang.subscribe((lang) => void this.setLanguage(lang));}- setLanguage(code: string) {+ async setLanguage(code: string) {+ await setYuccaLanguage(convertBCP47(code));+const item = langs.find((item) => item.code === code);if (!item) {return;diff --git a/web/src/lib/route.ts b/web/src/lib/route.tsindex f6c64878ab..a8e1e065ad 100644--- a/web/src/lib/route.ts+++ b/web/src/lib/route.ts@@ -142,6 +142,12 @@ export const Route = {workflows: () => '/workflows',viewWorkflow: ({ id }: { id: string }) => `/workflows/${id}`,+ // backups+ backups: () => '/admin/backups',+ backupSettings: () => '/admin/backups/settings',+ backupAttempts: () => '/admin/backups/attempts',+ backupSnapshots: () => '/admin/backups/snapshots',+// queuesqueues: () => '/admin/queues',viewQueue: ({ name }: { name: QueueName }) => `/admin/queues/${asQueueSlug(name)}`,diff --git a/web/src/lib/services/database-backups.service.ts b/web/src/lib/services/database-backups.service.tsindex ca5c1372d9..79454f7ace 100644--- a/web/src/lib/services/database-backups.service.ts+++ b/web/src/lib/services/database-backups.service.ts@@ -6,14 +6,41 @@ import { getFormatter } from '#lib/utils/i18n.ts';import {deleteDatabaseBackup,getBaseUrl,+ listDatabaseBackups,MaintenanceAction,setMaintenanceMode,+ type DatabaseBackupDto,type DatabaseBackupUploadDto,} from '@immich/sdk';import { modalManager, type ActionItem } from '@immich/ui';import { mdiDownload, mdiTrashCanOutline } from '@mdi/js';+import { DateTime } from 'luxon';import type { MessageFormatter } from 'svelte-i18n';+export const loadDatabaseBackups = async (): Promise<DatabaseBackupDto[]> => {+ const { backups } = await listDatabaseBackups();+ return backups;+};++export const getDatabaseBackupDateTime = (filename: string, zone?: string): DateTime | undefined => {+ const dateMatch = filename.match(/\d+T\d+/);+ if (!dateMatch) {+ return;+ }++ return DateTime.fromFormat(dateMatch[0], "yyyyMMdd'T'HHmmss", { zone });+};++const getBackupTimestamp = (backup: DatabaseBackupDto): number =>+ getDatabaseBackupDateTime(backup.filename, backup.timezone)?.toMillis() ?? 0;++export const getLatestBackup = (backups: DatabaseBackupDto[]): DatabaseBackupDto | undefined => {+ if (backups.length === 0) {+ return undefined;+ }+ return [...backups].sort((a, b) => getBackupTimestamp(b) - getBackupTimestamp(a))[0];+};+export const getDatabaseBackupActions = ($t: MessageFormatter, filename: string) => {const Download: ActionItem = {title: $t('download'),diff --git a/web/src/lib/stores/preferences.store.ts b/web/src/lib/stores/preferences.store.tsindex 42602816b3..473c01d0d8 100644--- a/web/src/lib/stores/preferences.store.ts+++ b/web/src/lib/stores/preferences.store.ts@@ -136,3 +136,5 @@ export const autoPlayVideo = persisted<boolean>('auto-play-video', true, {});export const alwaysLoadOriginalVideo = persisted<boolean>('always-load-original-video', false, {});export const recentAlbumsDropdown = persisted<boolean>('recent-albums-open', true, {});++export const hideBackupsReminder = persisted<boolean>('hide-backups-reminder', false, {});diff --git a/web/src/routes/+layout.ts b/web/src/routes/+layout.tsindex 2438fbb6d5..8f19d4a8b4 100644--- a/web/src/routes/+layout.ts+++ b/web/src/routes/+layout.ts@@ -1,9 +1,13 @@import { languageManager } from '#lib/managers/language-manager.svelte.ts';import { readPreloadedQuery } from '#lib/queries/client.ts';import { getServerConfigQuery } from '#lib/queries/server-info.query.ts';+import { lang } from '#lib/stores/preferences.store.ts';import { init } from '#lib/utils/client.ts';+import { convertBCP47 } from '#lib/utils/i18n.ts';import { maintenanceCreateUrl, maintenanceReturnUrl, maintenanceShouldRedirect } from '#lib/utils/maintenance.ts';+import { configureYucca } from '@futo-org/backups-orchestrator-ui';import { commandPaletteManager } from '@immich/ui';+import { get } from 'svelte/store';import { goto } from '$app/navigation';import type { LayoutLoad } from './$types';@@ -11,6 +15,8 @@ export const ssr = false;export const csr = true;export const load = (async ({ fetch, url }) => {+ configureYucca({ api: 'orchestrator', language: convertBCP47(get(lang)) });+let error;try {await init(fetch);diff --git a/web/src/routes/admin/backups/+page.svelte b/web/src/routes/admin/backups/+page.sveltenew file mode 100644index 0000000000..ec927227e3--- /dev/null+++ b/web/src/routes/admin/backups/+page.svelte@@ -0,0 +1,57 @@+<script lang="ts">+ import { goto } from '$app/navigation';+ import { ImmichBackupsPage, YuccaContext } from '@futo-org/backups-orchestrator-ui';+ import HideBackupsReminder from '#lib/components/backups/HideBackupsReminder.svelte';+ import AdminPageLayout from '#lib/components/layouts/AdminPageLayout.svelte';+ import { Route } from '#lib/route.ts';+ import type { ComponentProps } from 'svelte';+ import type { PageData } from './$types';++ type Props = {+ data: PageData;+ };++ const { data }: Props = $props();++ const questions: ComponentProps<typeof ImmichBackupsPage>['questions'] = [+ // {+ // title: 'Where can I store my backups?',+ // answer: 'TODO',+ // },+ // {+ // title: 'Does my Immich product key include FUTO Backups?',+ // answer: 'TODO',+ // },+ // {+ // title: 'Do I need FUTO Backups to use Immich?',+ // answer: 'TODO',+ // },+ // {+ // title: 'How is FUTO Cloud priced?',+ // answer: 'TODO',+ // },+ // {+ // title: 'What does FUTO Backups protect?',+ // answer: 'TODO',+ // },+ ];+</script>++{#snippet hideReminder()}+ <HideBackupsReminder />+{/snippet}++<YuccaContext>+ <ImmichBackupsPage+ questions={[{ title: 'Already back up your library elsewhere?', answer: hideReminder }, ...questions]}+ onConfigure={() => goto(Route.backupSettings())}+ onViewAttempts={() => goto(Route.backupAttempts())}+ onViewSnapshots={() => goto(Route.backupSnapshots())}+ >+ {#snippet layout({ actions, children })}+ <AdminPageLayout breadcrumbs={[{ title: data.meta.title }]} {actions}>+ {@render children()}+ </AdminPageLayout>+ {/snippet}+ </ImmichBackupsPage>+</YuccaContext>diff --git a/web/src/routes/admin/backups/+page.ts b/web/src/routes/admin/backups/+page.tsnew file mode 100644index 0000000000..e172cd85fc--- /dev/null+++ b/web/src/routes/admin/backups/+page.ts@@ -0,0 +1,29 @@+import { eventManager } from '#lib/managers/event-manager.svelte.ts';+import { authenticate } from '#lib/utils/auth.ts';+import { getFormatter } from '#lib/utils/i18n.ts';+import { getConfig, updateConfig } from '@immich/sdk';+import type { PageLoad } from './$types';++export const load = (async ({ url }) => {+ await authenticate(url, { admin: true });+ const $t = await getFormatter();++ try {+ const config = await getConfig();+ if (!config.backup.beta) {+ const newConfig = await updateConfig({+ adminConfigDto: { ...config, backup: { ...config.backup, beta: true } },+ });++ eventManager.emit('SystemConfigUpdate', newConfig);+ }+ } catch {+ // no-op+ }++ return {+ meta: {+ title: $t('admin.backups'),+ },+ };+}) satisfies PageLoad;diff --git a/web/src/routes/admin/backups/attempts/+page.svelte b/web/src/routes/admin/backups/attempts/+page.sveltenew file mode 100644index 0000000000..37d9fcf32c--- /dev/null+++ b/web/src/routes/admin/backups/attempts/+page.svelte@@ -0,0 +1,20 @@+<script lang="ts">+ import { goto } from '$app/navigation';+ import { ImmichBackupAttemptsPage, YuccaContext } from '@futo-org/backups-orchestrator-ui';+ import AdminPageLayout from '#lib/components/layouts/AdminPageLayout.svelte';+ import { Route } from '#lib/route.ts';+ import { t } from 'svelte-i18n';+ import type { PageData } from './$types';++ type Props = {+ data: PageData;+ };++ const { data }: Props = $props();+</script>++<YuccaContext>+ <AdminPageLayout breadcrumbs={[{ title: $t('admin.backups'), href: Route.backups() }, { title: data.meta.title }]}>+ <ImmichBackupAttemptsPage onUnconfigured={() => goto(Route.backups())} />+ </AdminPageLayout>+</YuccaContext>diff --git a/web/src/routes/admin/backups/attempts/+page.ts b/web/src/routes/admin/backups/attempts/+page.tsnew file mode 100644index 0000000000..34f673ca4a--- /dev/null+++ b/web/src/routes/admin/backups/attempts/+page.ts@@ -0,0 +1,14 @@+import { authenticate } from '#lib/utils/auth.ts';+import { getFormatter } from '#lib/utils/i18n.ts';+import type { PageLoad } from './$types';++export const load = (async ({ url }) => {+ await authenticate(url, { admin: true });+ const $t = await getFormatter();++ return {+ meta: {+ title: $t('admin.backups_attempts'),+ },+ };+}) satisfies PageLoad;diff --git a/web/src/routes/admin/backups/settings/+page.svelte b/web/src/routes/admin/backups/settings/+page.sveltenew file mode 100644index 0000000000..880aa3cbd5--- /dev/null+++ b/web/src/routes/admin/backups/settings/+page.svelte@@ -0,0 +1,20 @@+<script lang="ts">+ import { goto } from '$app/navigation';+ import { ImmichBackupSettingsPage, YuccaContext } from '@futo-org/backups-orchestrator-ui';+ import AdminPageLayout from '#lib/components/layouts/AdminPageLayout.svelte';+ import { Route } from '#lib/route.ts';+ import { t } from 'svelte-i18n';+ import type { PageData } from './$types';++ type Props = {+ data: PageData;+ };++ const { data }: Props = $props();+</script>++<YuccaContext>+ <AdminPageLayout breadcrumbs={[{ title: $t('admin.backups'), href: Route.backups() }, { title: data.meta.title }]}>+ <ImmichBackupSettingsPage onUnconfigured={() => goto(Route.backups())} />+ </AdminPageLayout>+</YuccaContext>diff --git a/web/src/routes/admin/backups/settings/+page.ts b/web/src/routes/admin/backups/settings/+page.tsnew file mode 100644index 0000000000..5a92bc576c--- /dev/null+++ b/web/src/routes/admin/backups/settings/+page.ts@@ -0,0 +1,14 @@+import { authenticate } from '#lib/utils/auth.ts';+import { getFormatter } from '#lib/utils/i18n.ts';+import type { PageLoad } from './$types';++export const load = (async ({ url }) => {+ await authenticate(url, { admin: true });+ const $t = await getFormatter();++ return {+ meta: {+ title: $t('admin.backups_settings'),+ },+ };+}) satisfies PageLoad;diff --git a/web/src/routes/admin/backups/snapshots/+page.svelte b/web/src/routes/admin/backups/snapshots/+page.sveltenew file mode 100644index 0000000000..7e9caf44b4--- /dev/null+++ b/web/src/routes/admin/backups/snapshots/+page.svelte@@ -0,0 +1,20 @@+<script lang="ts">+ import { goto } from '$app/navigation';+ import { ImmichSnapshotsPage, YuccaContext } from '@futo-org/backups-orchestrator-ui';+ import AdminPageLayout from '#lib/components/layouts/AdminPageLayout.svelte';+ import { Route } from '#lib/route.ts';+ import { t } from 'svelte-i18n';+ import type { PageData } from './$types';++ type Props = {+ data: PageData;+ };++ const { data }: Props = $props();+</script>++<YuccaContext>+ <AdminPageLayout breadcrumbs={[{ title: $t('admin.backups'), href: Route.backups() }, { title: data.meta.title }]}>+ <ImmichSnapshotsPage onUnconfigured={() => goto(Route.backups())} />+ </AdminPageLayout>+</YuccaContext>diff --git a/web/src/routes/admin/backups/snapshots/+page.ts b/web/src/routes/admin/backups/snapshots/+page.tsnew file mode 100644index 0000000000..a46acf8abe--- /dev/null+++ b/web/src/routes/admin/backups/snapshots/+page.ts@@ -0,0 +1,14 @@+import { authenticate } from '#lib/utils/auth.ts';+import { getFormatter } from '#lib/utils/i18n.ts';+import type { PageLoad } from './$types';++export const load = (async ({ url }) => {+ await authenticate(url, { admin: true });+ const $t = await getFormatter();++ return {+ meta: {+ title: $t('admin.backups_snapshots'),+ },+ };+}) satisfies PageLoad;diff --git a/web/src/routes/admin/system-settings/BackupSettings.svelte b/web/src/routes/admin/system-settings/BackupSettings.svelteindex c2c2b5017c..338ac09577 100644--- a/web/src/routes/admin/system-settings/BackupSettings.svelte+++ b/web/src/routes/admin/system-settings/BackupSettings.svelte@@ -71,7 +71,7 @@inputType={SettingInputFieldType.NUMBER}required={true}label={$t('admin.backup_keep_last_amount')}- disabled={disabled || !configToEdit.backup.database.enabled}+ {disabled}bind:value={configToEdit.backup.database.keepLastAmount}isEdited={configToEdit.backup.database.keepLastAmount !== config.backup.database.keepLastAmount}/>diff --git a/web/src/routes/link/+page.ts b/web/src/routes/link/+page.tsindex ad4878d04a..aea2793853 100644--- a/web/src/routes/link/+page.ts+++ b/web/src/routes/link/+page.ts@@ -8,6 +8,7 @@ enum LinkTarget {UNSUBSCRIBE = 'unsubscribe',VIEW_ASSET = 'view_asset',ACTIVATE_LICENSE = 'activate_license',+ BACKUPS = 'backups',}export const load = (({ url }) => {@@ -22,6 +23,10 @@ export const load = (({ url }) => {return redirect(307, Route.userSettings({ isOpen: OpenQueryParam.NOTIFICATIONS }));}+ case LinkTarget.BACKUPS: {+ return redirect(307, Route.backups());+ }+case LinkTarget.VIEW_ASSET: {const id = queryParams.get('id');if (id) {diff --git a/web/src/routes/maintenance/+page.svelte b/web/src/routes/maintenance/+page.svelteindex cf5f9cae3f..3be727cc85 100644--- a/web/src/routes/maintenance/+page.svelte+++ b/web/src/routes/maintenance/+page.svelte@@ -7,6 +7,7 @@import { maintenanceStore } from '#lib/stores/maintenance.store.ts';import { MaintenanceAction } from '@immich/sdk';import { Button, Heading, Link, ProgressBar, Scrollable, Text } from '@immich/ui';+ import { YuccaContext, ViewStatusModal } from '@futo-org/backups-orchestrator-ui';import { t } from 'svelte-i18n';import type { PageData } from './$types';@@ -30,6 +31,11 @@action: MaintenanceAction.End,});+ const startRestore = () =>+ handleSetMaintenanceMode({+ action: MaintenanceAction.SelectDatabaseRestore,+ });+const error = $derived($status?.error?.split('\n')@@ -38,58 +44,79 @@);</script>-<AuthPageLayout- withHeader={$status?.action === MaintenanceAction.Start || $status?.action === MaintenanceAction.End}- withBackdrop={$status?.action === MaintenanceAction.Start}->- <div class="flex flex-col place-items-center gap-8 text-center">- {#if $status?.action === MaintenanceAction.RestoreDatabase}- <Heading size="large" color="primary" tag="h1">{$t('maintenance_action_restore')}</Heading>- {#if $status.error}- <Scrollable class="max-h-80">- <pre class="text-left text-sm"><code>{error}</code></pre>- </Scrollable>- <Button onclick={end}>{$t('maintenance_end')}</Button>- {:else}- <ProgressBar progress={$status.progress || 0} />- {#if $status.task === 'backup'}- <Text>{$t('maintenance_task_backup')}</Text>- {/if}- {#if $status.task === 'restore'}- <Text>{$t('maintenance_task_restore')}</Text>- {/if}- {#if $status.task === 'migrations'}- <Text>{$t('maintenance_task_migrations')}</Text>- {/if}- {#if $status.task === 'rollback'}- <Text>{$t('maintenance_task_rollback')}</Text>+{#snippet errorLog()}+ <Scrollable class="max-h-80">+ <pre class="text-left text-sm"><code>{error}</code></pre>+ </Scrollable>+ <Button onclick={end}>{$t('maintenance_end')}</Button>+{/snippet}++<YuccaContext>+ <AuthPageLayout+ withHeader={$status?.action === MaintenanceAction.Start || $status?.action === MaintenanceAction.End}+ withBackdrop={$status?.action === MaintenanceAction.Start}+ >+ <div class="flex flex-col place-items-center gap-8 text-center">+ {#if $status?.action === MaintenanceAction.RestoreDatabase}+ <Heading size="large" color="primary" tag="h1">{$t('maintenance_action_restore')}</Heading>+ {#if $status.error}+ {@render errorLog()}+ {:else}+ <ProgressBar progress={$status.progress || 0} />+ {#if $status.task === 'backup'}+ <Text>{$t('maintenance_task_backup')}</Text>+ {/if}+ {#if $status.task === 'restore'}+ <Text>{$t('maintenance_task_restore')}</Text>+ {/if}+ {#if $status.task === 'migrations'}+ <Text>{$t('maintenance_task_migrations')}</Text>+ {/if}+ {#if $status.task === 'rollback'}+ <Text>{$t('maintenance_task_rollback')}</Text>+ {/if}{/if}- {/if}- {:else if $status?.action === MaintenanceAction.SelectDatabaseRestore && $auth}- <MaintenanceRestoreFlow {end} expectedVersion={data.expectedVersion} />- {:else}- <Heading size="large" color="primary" tag="h1">{$t('maintenance_title')}</Heading>- <p>- <FormatMessage key="maintenance_description">- {#snippet children({ tag, message })}- {#if tag === 'link'}- <Link href="https://docs.immich.app/administration/maintenance-mode">- {message}- </Link>- {/if}- {/snippet}- </FormatMessage>- </p>- {#if $auth}+ {:else if $status?.action === MaintenanceAction.Rollback && $status.futoBackupsJobId}+ <ViewStatusModal+ jobId={$status.futoBackupsJobId}+ onClose={() => {+ if ($status?.error) {+ $status.futoBackupsJobId = '';+ }+ }}+ />+ {:else if $status?.action === MaintenanceAction.Rollback && $status.error}+ <Heading size="large" color="primary" tag="h1">{$t('maintenance_action_rollback')}</Heading>+ {@render errorLog()}+ {:else if $status?.action === MaintenanceAction.SelectDatabaseRestore && $auth}+ <MaintenanceRestoreFlow {end} expectedVersion={data.expectedVersion} />+ {:else}+ <Heading size="large" color="primary" tag="h1">{$t('maintenance_title')}</Heading><p>- {$t('maintenance_logged_in_as', {- values: {- user: $auth.username,- },- })}+ <FormatMessage key="maintenance_description">+ {#snippet children({ tag, message })}+ {#if tag === 'link'}+ <Link href="https://docs.immich.app/administration/maintenance-mode">+ {message}+ </Link>+ {/if}+ {/snippet}+ </FormatMessage></p>- <Button onclick={end}>{$t('maintenance_end')}</Button>+ {#if $auth}+ <p>+ {$t('maintenance_logged_in_as', {+ values: {+ user: $auth.username,+ },+ })}+ </p>+ <div class="flex gap-2">+ <Button color="secondary" onclick={startRestore}>{$t('maintenance_restore_from_backup')}</Button>+ <Button onclick={end}>{$t('maintenance_end')}</Button>+ </div>+ {/if}{/if}- {/if}- </div>-</AuthPageLayout>+ </div>+ </AuthPageLayout>+</YuccaContext>diff --git a/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte b/web/src/routes/maintenance/MaintenanceRestoreFlow.svelteindex 97119ea2f9..76b2b9b704 100644--- a/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte+++ b/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte@@ -1,6 +1,9 @@<script lang="ts">+ import RestoreFlowAutoSelectBackup from './RestoreFlowAutoSelectBackup.svelte';import RestoreFlowDetectInstall from './RestoreFlowDetectInstall.svelte';+ import RestoreFlowIntro from './RestoreFlowIntro.svelte';import RestoreFlowSelectBackup from './RestoreFlowSelectBackup.svelte';+ import { ImmichOnboardingRestoreFlow } from '@futo-org/backups-orchestrator-ui';type Props = {end: () => void;@@ -9,11 +12,31 @@const { end, expectedVersion }: Props = $props();- let stage = $state(0);+ let stage: 'overview' | 'futo-backups' | 'detect-install' | 'auto-select-backup' | 'select-backup' = $state(+ localStorage.getItem('restoring-futo-backups') ? 'futo-backups' : 'overview',+ );++ $effect(() => {+ if (stage === 'futo-backups') {+ localStorage.setItem('restoring-futo-backups', '1');+ } else {+ localStorage.removeItem('restoring-futo-backups');+ }+ });</script>-{#if stage === 0}- <RestoreFlowDetectInstall next={() => stage++} {end} />-{:else}- <RestoreFlowSelectBackup previous={() => stage--} {end} {expectedVersion} />+{#if stage === 'overview'}+ <RestoreFlowIntro+ flowToFutoBackups={() => (stage = 'futo-backups')}+ flowToDatabase={() => (stage = 'detect-install')}+ {end}+ />+{:else if stage === 'futo-backups'}+ <ImmichOnboardingRestoreFlow onExit={() => (stage = 'overview')} onFinish={() => (stage = 'auto-select-backup')} />+{:else if stage === 'detect-install'}+ <RestoreFlowDetectInstall next={() => (stage = 'select-backup')} previous={() => (stage = 'overview')} />+{:else if stage === 'select-backup'}+ <RestoreFlowSelectBackup previous={() => (stage = 'detect-install')} {end} {expectedVersion} />+{:else if stage === 'auto-select-backup'}+ <RestoreFlowAutoSelectBackup selectAnother={() => (stage = 'select-backup')} {end} {expectedVersion} />{/if}diff --git a/web/src/routes/maintenance/RestoreFlowAutoSelectBackup.svelte b/web/src/routes/maintenance/RestoreFlowAutoSelectBackup.sveltenew file mode 100644index 0000000000..e94c5d9f99--- /dev/null+++ b/web/src/routes/maintenance/RestoreFlowAutoSelectBackup.svelte@@ -0,0 +1,68 @@+<script lang="ts">+ import MaintenanceBackupCard from '#lib/components/maintenance/MaintenanceBackupCard.svelte';+ import {+ getLatestBackup,+ handleRestoreDatabaseBackup,+ loadDatabaseBackups,+ } from '#lib/services/database-backups.service.ts';+ import type { DatabaseBackupDto } from '@immich/sdk';+ import { Alert, Button, Heading, HStack, Icon, Text } from '@immich/ui';+ import { mdiArrowRight, mdiRefresh } from '@mdi/js';+ import { handleError } from '#lib/utils/handle-error.ts';+ import { onMount } from 'svelte';+ import { t } from 'svelte-i18n';++ type Props = {+ selectAnother: () => void;+ end: () => void;+ expectedVersion: string;+ };++ const { selectAnother, end, expectedVersion }: Props = $props();++ let backups: DatabaseBackupDto[] | undefined = $state();++ onMount(async () => {+ try {+ backups = await loadDatabaseBackups();+ } catch (error) {+ handleError(error, $t('errors.failed_to_load_database_backups'));+ backups = [];+ }+ });++ const latest = $derived(backups ? getLatestBackup(backups) : undefined);+</script>++<Heading size="large" color="primary" tag="h1">{$t('maintenance_restore_from_backup')}</Heading>++{#if backups === undefined}+ <HStack>+ <Icon icon={mdiRefresh} color="rgb(var(--immich-ui-primary))" />+ <Text>{$t('maintenance_restore_loading_backups')}</Text>+ </HStack>+{:else if latest === undefined}+ <Alert color="warning" title={$t('maintenance_restore_no_backups')} />+ <HStack>+ <Button onclick={end} variant="ghost">{$t('cancel')}</Button>+ <Button onclick={selectAnother}>{$t('maintenance_restore_upload_backup')}</Button>+ </HStack>+{:else}+ <Text>{$t('maintenance_restore_latest_backup_description')}</Text>+ <MaintenanceBackupCard+ filename={latest.filename}+ filesize={latest.filesize}+ timezone={latest.timezone}+ {expectedVersion}+ showFullDate+ class="text-left"+ />++ <HStack>+ <Button onclick={end} variant="ghost">{$t('cancel')}</Button>+ <Button onclick={selectAnother} variant="ghost">{$t('maintenance_restore_select_another')}</Button>+ <Button onclick={() => handleRestoreDatabaseBackup(latest.filename)} trailingIcon={mdiArrowRight}>+ {$t('continue')}+ </Button>+ </HStack>+{/if}diff --git a/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte b/web/src/routes/maintenance/RestoreFlowDetectInstall.svelteindex c0461394f8..08009e6a26 100644--- a/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte+++ b/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte@@ -7,10 +7,10 @@type Props = {next: () => void;- end: () => void;+ previous: () => void;};- const { next, end }: Props = $props();+ const { next, previous }: Props = $props();let detectedInstall: MaintenanceDetectInstallResponseDto | undefined = $state();@@ -92,6 +92,6 @@</div><Text>{$t('maintenance_restore_library_confirm')}</Text><HStack>- <Button onclick={end} variant="ghost">{$t('cancel')}</Button>+ <Button onclick={previous} variant="ghost">{$t('back')}</Button><Button onclick={next} trailingIcon={mdiArrowRight}>{$t('next')}</Button></HStack>diff --git a/web/src/routes/maintenance/RestoreFlowIntro.svelte b/web/src/routes/maintenance/RestoreFlowIntro.sveltenew file mode 100644index 0000000000..83a3a1db28--- /dev/null+++ b/web/src/routes/maintenance/RestoreFlowIntro.svelte@@ -0,0 +1,24 @@+<script lang="ts">+ import { Button, Heading, HStack } from '@immich/ui';+ import { mdiArrowRight } from '@mdi/js';+ import { t } from 'svelte-i18n';++ type Props = {+ flowToFutoBackups: () => void;+ flowToDatabase: () => void;+ end: () => void;+ };++ const { flowToFutoBackups, flowToDatabase, end }: Props = $props();+</script>++<Heading size="large" color="primary" tag="h1">{$t('maintenance_restore_source_title')}</Heading>+<HStack>+ <Button onclick={end} variant="ghost">{$t('cancel')}</Button>+ <Button onclick={flowToFutoBackups} trailingIcon={mdiArrowRight}+ >{$t('maintenance_restore_source_futo_backups')}</Button+ >+ <Button onclick={flowToDatabase} trailingIcon={mdiArrowRight}+ >{$t('maintenance_restore_source_database_backup')}</Button+ >+</HStack>diff --git a/web/vite.config.ts b/web/vite.config.tsindex 7c1ab55552..a0ce7f8099 100644--- a/web/vite.config.ts+++ b/web/vite.config.ts@@ -137,5 +137,10 @@ export default defineConfig({env: {TZ: 'UTC',},+ server: {+ deps: {+ inline: ['@futo-org/backups-orchestrator-ui', '@material-symbols/svg-400'],+ },+ },},} as UserConfig);