@futo-org/backups-orchestrator-ui 0.45.0 → 0.46.0

package/dist/components/integrations/immich/ImmichBackupSettingsPage.svelte

@@ -2,6 +2,7 @@
   import { Container } from "@immich/ui";
   import ImmichConfiguredGate from "./ImmichConfiguredGate.svelte";
   import ImmichSettingsBackupContents from "./settings/ImmichSettingsBackupContents.svelte";
+  import ImmichSettingsBandwidth from "./settings/ImmichSettingsBandwidth.svelte";
   import ImmichSettingsSchedule from "./settings/ImmichSettingsSchedule.svelte";
   import ImmichSettingsStorage from "./settings/ImmichSettingsStorage.svelte";
 
@@ -17,6 +18,7 @@
     <Container size="large" center>
       <ImmichSettingsBackupContents />
       <ImmichSettingsSchedule />
+      <ImmichSettingsBandwidth />
       <ImmichSettingsStorage />
     </Container>
   {/snippet}

package/dist/components/integrations/immich/ImmichBackupsSidebarItem.svelte

@@ -7,6 +7,7 @@
   } from "../../../services/immich.integration.service";
   import { HStack, Icon, LoadingSpinner, Text } from "@immich/ui";
   import {
+    mdiAlertCircleOutline,
     mdiChevronRight,
     mdiCloudAlertOutline,
     mdiCloudCheckVariantOutline,
@@ -29,6 +30,10 @@
   const configured = $derived(status.kind !== "unconfigured");
 
   const appearance = $derived.by(() => {
+    if (backup.needsAttention) {
+      return { color: "warning", icon: mdiAlertCircleOutline } as const;
+    }
+
     switch (status.kind) {
       case "loading": {
         return { color: "secondary", icon: undefined } as const;
@@ -85,7 +90,9 @@
   {/if}
 
   <Text size="tiny" class="flex-1 leading-tight">
-    {#if status.kind === "loading"}
+    {#if backup.needsAttention}
+      Needs attention
+    {:else if status.kind === "loading"}
       Checking backup status
     {:else if status.kind === "offline"}
       Backup service is offline

package/dist/components/integrations/immich/ImmichDatabaseDumpAlert.svelte

@@ -0,0 +1,42 @@
+<script lang="ts">
+  import {
+    useConfigureImmichDatabaseDump,
+    useIgnoreImmichDatabaseDumpWarning,
+    useImmichBackupStatus,
+  } from "../../../services/immich.integration.service";
+  import { Alert, Button, HStack, Stack, Text } from "@immich/ui";
+
+  const backup = useImmichBackupStatus();
+  const configure = useConfigureImmichDatabaseDump();
+  const ignore = useIgnoreImmichDatabaseDumpWarning();
+</script>
+
+{#if backup.needsAttention}
+  <Alert color="warning" title="Immich database backups are still enabled">
+    <Stack gap={3}>
+      <Text size="small">
+        FUTO Backups already creates the same database backups as Immich.
+        <br />
+        Most users should select "use FUTO Backups only".
+      </Text>
+      <HStack gap={2}>
+        <Button
+          size="small"
+          color="primary"
+          loading={configure.isPending}
+          onclick={() => configure.mutate({ enabled: false })}
+        >
+          Use FUTO Backups only
+        </Button>
+        <Button
+          size="small"
+          variant="ghost"
+          loading={ignore.isPending}
+          onclick={() => ignore.mutate()}
+        >
+          Ignore
+        </Button>
+      </HStack>
+    </Stack>
+  </Alert>
+{/if}

package/dist/components/integrations/immich/ImmichDatabaseDumpAlert.svelte.d.ts

@@ -0,0 +1,18 @@
+interface $$__sveltets_2_IsomorphicComponent<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any, Exports = {}, Bindings = string> {
+    new (options: import('svelte').ComponentConstructorOptions<Props>): import('svelte').SvelteComponent<Props, Events, Slots> & {
+        $$bindings?: Bindings;
+    } & Exports;
+    (internal: unknown, props: {
+        $$events?: Events;
+        $$slots?: Slots;
+    }): Exports & {
+        $set?: any;
+        $on?: any;
+    };
+    z_$$bindings?: Bindings;
+}
+declare const ImmichDatabaseDumpAlert: $$__sveltets_2_IsomorphicComponent<Record<string, never>, {
+    [evt: string]: CustomEvent<any>;
+}, {}, {}, string>;
+type ImmichDatabaseDumpAlert = InstanceType<typeof ImmichDatabaseDumpAlert>;
+export default ImmichDatabaseDumpAlert;

package/dist/components/integrations/immich/ImmichManageBackupPage.svelte

@@ -10,6 +10,7 @@
     useImmichBackupStatusEventHandler,
   } from "../../../services/immich.integration.service";
   import { Container, Stack } from "@immich/ui";
+  import ImmichDatabaseDumpAlert from "./ImmichDatabaseDumpAlert.svelte";
   import ImmichManageBackupOverview from "./ImmichManageBackupOverview.svelte";
 
   type Props = {
@@ -35,6 +36,7 @@
   <Container size="medium" center>
     {#if repository && schedule}
       <Stack class="mt-4" gap={6}>
+        <ImmichDatabaseDumpAlert />
         <ImmichManageBackupOverview {repository} {schedule} status={backup.status} />
         <BackendsList {repository} />
         <RepositoryRunHistory {repository} onViewAll={onViewAttempts} />

package/dist/components/integrations/immich/settings/ImmichSettingsBandwidth.svelte

@@ -0,0 +1,150 @@
+<script lang="ts">
+  import Accordion from "../../../ui/Accordion.svelte";
+  import { useConfig, useUpdateConfig } from "../../../../services/config.service";
+  import {
+    Button,
+    Field,
+    HStack,
+    LoadingSpinner,
+    Select,
+    Stack,
+    Switch,
+    Text,
+  } from "@immich/ui";
+  import { mdiSpeedometerSlow } from "@mdi/js";
+
+  const bytesPerMegabyte = 1_000_000;
+  const unlimited = "0";
+
+  const speeds = [
+    { value: unlimited, label: "No limit" },
+    ...[0.5, 1, 2, 5, 10, 20, 50, 100].map((megabytes) => ({
+      value: String(megabytes * bytesPerMegabyte),
+      label: `${megabytes} MB/s`,
+    })),
+  ];
+
+  const hours = Array.from({ length: 24 }, (_, hour) => ({
+    value: `${String(hour).padStart(2, "0")}:00`,
+    label: `${String(hour).padStart(2, "0")}:00`,
+  }));
+
+  const defaultQuietHoursStart = "22:00";
+  const defaultQuietHoursEnd = "06:00";
+
+  const config = useConfig();
+  const mutation = useUpdateConfig();
+
+  let speed = $state(unlimited);
+  let quiet = $state(false);
+  let quietStart = $state(defaultQuietHoursStart);
+  let quietEnd = $state(defaultQuietHoursEnd);
+  let loaded = false;
+
+  const load = () => {
+    if (!config.data) {
+      return;
+    }
+
+    const { bytesPerSec, quietHours } = config.data.bandwidth;
+    const [start = defaultQuietHoursStart, end = defaultQuietHoursEnd] =
+      quietHours?.split("-") ?? [];
+
+    speed = String(bytesPerSec);
+    quiet = Boolean(quietHours);
+    quietStart = start;
+    quietEnd = end;
+  };
+
+  $effect(() => {
+    if (loaded || !config.data) {
+      return;
+    }
+
+    loaded = true;
+    load();
+  });
+
+  const limited = $derived(speed !== unlimited);
+
+  const onSave = () => {
+    mutation.mutate({
+      bandwidth: {
+        bytesPerSec: Number(speed),
+        quietHours: limited && quiet ? `${quietStart}-${quietEnd}` : undefined,
+      },
+    });
+  };
+</script>
+
+<Accordion
+  title="Bandwidth"
+  subtitle="Manage how fast backups upload."
+  icon={mdiSpeedometerSlow}
+>
+  <Stack gap={4} class="pt-2">
+    {#if config.isLoading}
+      <LoadingSpinner />
+    {:else}
+      <Field
+        label="Upload speed"
+        description="Slow down backup uploads without affecting restores."
+        color="primary"
+      >
+        <Select
+          options={speeds}
+          value={speed}
+          onChange={(value) => (speed = value)}
+        />
+      </Field>
+
+      <Field
+        label="Full speed during quiet hours"
+        description="Lift the limit while you are asleep."
+        color="primary"
+        disabled={!limited}
+      >
+        <Switch bind:checked={quiet} />
+      </Field>
+
+      {#if limited && quiet}
+        <HStack gap={4}>
+          <Field label="From" color="primary">
+            <Select
+              options={hours}
+              value={quietStart}
+              onChange={(value) => (quietStart = value)}
+            />
+          </Field>
+          <Field label="Until" color="primary">
+            <Select
+              options={hours}
+              value={quietEnd}
+              onChange={(value) => (quietEnd = value)}
+            />
+          </Field>
+        </HStack>
+
+        {#if quietStart === quietEnd}
+          <Text size="small" color="muted">
+            With the same start and end time, the limit never applies.
+          </Text>
+        {/if}
+      {/if}
+
+      <HStack gap={2} class="justify-end">
+        <Button
+          shape="round"
+          color="secondary"
+          disabled={mutation.isPending}
+          onclick={load}
+        >
+          Reset
+        </Button>
+        <Button shape="round" loading={mutation.isPending} onclick={onSave}>
+          Save
+        </Button>
+      </HStack>
+    {/if}
+  </Stack>
+</Accordion>

package/dist/components/integrations/immich/settings/ImmichSettingsBandwidth.svelte.d.ts

@@ -0,0 +1,3 @@
+declare const ImmichSettingsBandwidth: import("svelte").Component<Record<string, never>, {}, "">;
+type ImmichSettingsBandwidth = ReturnType<typeof ImmichSettingsBandwidth>;
+export default ImmichSettingsBandwidth;

package/dist/fetch-client.d.ts

@@ -47,6 +47,16 @@ export type CreateLocalBackendRequestDto = {
 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 = {
     path: string;
     isDirectory: boolean;
@@ -146,12 +156,18 @@ export type RunDto = {
     status: RunStatus;
     "type": RunType;
 };
+export type ImmichDatabaseDumpConfigDto = {
+    enabled: boolean;
+    keepLastAmount: number;
+};
 export type ImmichBackupStatusDto = {
     integration?: ImmichIntegrationDto;
     repository?: LocalRepositoryDto;
     backend?: BackendDto;
     schedule?: ScheduleDto;
     latestBackupRun?: RunDto;
+    databaseDump?: ImmichDatabaseDumpConfigDto;
+    databaseDumpWarningIgnored?: boolean;
 };
 export type ConfigureImmichIntegrationRequestDto = {
     name: string;
@@ -167,6 +183,10 @@ export type ConfigureImmichIntegrationRequestDto = {
 export type ConfigureImmichIntegrationResponseDto = {
     repositoryId: string;
 };
+export type ConfigureImmichDatabaseDumpRequestDto = {
+    enabled?: boolean;
+    keepLastAmount?: number;
+};
 export type ImmichRollbackRequestDto = {
     repositoryId: string;
     snapshotId: string;
@@ -313,6 +333,8 @@ export declare function createSession(createSessionRequestDto: CreateSessionRequ
 export declare function createTicket(ticketCreateRequestDto: TicketCreateRequestDto, opts?: Oazapfts.RequestOpts): Promise<TicketCreateResponseDto>;
 export declare function getBackends(opts?: Oazapfts.RequestOpts): Promise<BackendsResponseDto>;
 export declare function createLocalBackend(createLocalBackendRequestDto: CreateLocalBackendRequestDto, opts?: Oazapfts.RequestOpts): Promise<BackendResponseDto>;
+export declare function getConfig(opts?: Oazapfts.RequestOpts): Promise<ConfigResponseDto>;
+export declare function updateConfig(configUpdateRequestDto: ConfigUpdateRequestDto, opts?: Oazapfts.RequestOpts): Promise<ConfigResponseDto>;
 export declare function resetOrchestrator(opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function getFileListing({ path }?: {
     path?: string;
@@ -320,6 +342,8 @@ export declare function getFileListing({ path }?: {
 export declare function getIntegrations(opts?: Oazapfts.RequestOpts): Promise<IntegrationsResponseDto>;
 export declare function getImmichBackupStatus(opts?: Oazapfts.RequestOpts): Promise<ImmichBackupStatusDto>;
 export declare function configureImmichIntegration(configureImmichIntegrationRequestDto: ConfigureImmichIntegrationRequestDto, opts?: Oazapfts.RequestOpts): Promise<ConfigureImmichIntegrationResponseDto>;
+export declare function ignoreImmichDatabaseDumpWarning(opts?: Oazapfts.RequestOpts): Promise<never>;
+export declare function configureImmichDatabaseDump(configureImmichDatabaseDumpRequestDto: ConfigureImmichDatabaseDumpRequestDto, opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function startImmichRollback(immichRollbackRequestDto: ImmichRollbackRequestDto, opts?: Oazapfts.RequestOpts): Promise<never>;
 export declare function onboardingStatus(opts?: Oazapfts.RequestOpts): Promise<OnboardingStatusResponseDto>;
 export declare function currentRecoveryKey(opts?: Oazapfts.RequestOpts): Promise<CurrentRecoveryKeyResponse>;

package/dist/fetch-client.js

@@ -48,6 +48,18 @@ export function createLocalBackend(createLocalBackendRequestDto, opts) {
         body: createLocalBackendRequestDto
     })));
 }
+export function getConfig(opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/api/yucca/config", {
+        ...opts
+    }));
+}
+export function updateConfig(configUpdateRequestDto, opts) {
+    return oazapfts.ok(oazapfts.fetchJson("/api/yucca/config", oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: configUpdateRequestDto
+    })));
+}
 export function resetOrchestrator(opts) {
     return oazapfts.ok(oazapfts.fetchText("/api/yucca/debug/reset", {
         ...opts,
@@ -78,6 +90,19 @@ export function configureImmichIntegration(configureImmichIntegrationRequestDto,
         body: configureImmichIntegrationRequestDto
     })));
 }
+export function ignoreImmichDatabaseDumpWarning(opts) {
+    return oazapfts.ok(oazapfts.fetchText("/api/yucca/integrations/immich/database-dump/ignore-warning", {
+        ...opts,
+        method: "POST"
+    }));
+}
+export function configureImmichDatabaseDump(configureImmichDatabaseDumpRequestDto, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/api/yucca/integrations/immich/database-dump", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: configureImmichDatabaseDumpRequestDto
+    })));
+}
 export function startImmichRollback(immichRollbackRequestDto, opts) {
     return oazapfts.ok(oazapfts.fetchText("/api/yucca/integrations/immich/rollback", oazapfts.json({
         ...opts,

package/dist/services/config.service.d.ts

@@ -0,0 +1,6 @@
+import { type ConfigUpdateRequestDto } from '../fetch-client';
+export declare const configKeys: {
+    all: readonly ["config"];
+};
+export declare const useConfig: () => import("@tanstack/svelte-query").CreateQueryResult<import("../fetch-client").ConfigResponseDto, Error>;
+export declare const useUpdateConfig: () => import("@tanstack/svelte-query").CreateMutationResult<import("../fetch-client").ConfigResponseDto, Error, ConfigUpdateRequestDto, unknown>;

package/dist/services/config.service.js

@@ -0,0 +1,16 @@
+import { getConfig, updateConfig, } from '../fetch-client';
+import { queryClient } from '../query-client';
+import { handleError } from '../utils/handle-error';
+import { createMutation, createQuery } from '@tanstack/svelte-query';
+export const configKeys = {
+    all: ['config'],
+};
+export const useConfig = () => createQuery(() => ({
+    queryKey: configKeys.all,
+    queryFn: () => getConfig(),
+}), () => queryClient);
+export const useUpdateConfig = () => createMutation(() => ({
+    mutationFn: (dto) => updateConfig(dto),
+    onSuccess: (config) => queryClient.setQueryData(configKeys.all, config),
+    onError: (error) => handleError(error, 'Failed to save settings'),
+}), () => queryClient);

package/dist/services/immich.integration.service.d.ts

@@ -1,4 +1,5 @@
 import { type ActionItem } from '@immich/ui';
+import { type ConfigureImmichDatabaseDumpRequestDto } from '../fetch-client';
 export declare const getBackupPageActions: (repositoryId: string | undefined, onConfigure: () => void) => {
     Configure: ActionItem;
     ViewRecoveryKey: ActionItem;
@@ -25,4 +26,7 @@ export declare const useImmichBackupStatus: () => {
     readonly repository: import("../fetch-client").LocalRepositoryDto | undefined;
     readonly schedule: import("../fetch-client").ScheduleDto | undefined;
     readonly status: ImmichBackupStatus;
+    readonly needsAttention: boolean;
 };
+export declare const useConfigureImmichDatabaseDump: () => import("@tanstack/svelte-query").CreateMutationResult<never, Error, ConfigureImmichDatabaseDumpRequestDto, unknown>;
+export declare const useIgnoreImmichDatabaseDumpWarning: () => import("@tanstack/svelte-query").CreateMutationResult<never, Error, void, unknown>;

package/dist/services/immich.integration.service.js

@@ -1,10 +1,11 @@
 import BackupsRecoveryKeyModal from '../components/onboarding/dialogs/BackupsRecoveryKeyModal.svelte';
 import { modalManager } from '@immich/ui';
 import { mdiCloudUploadOutline, mdiCogOutline, mdiKeyOutline } from '@mdi/js';
-import { getImmichBackupStatus, } from '../fetch-client';
+import { configureImmichDatabaseDump, getImmichBackupStatus, ignoreImmichDatabaseDumpWarning, } from '../fetch-client';
 import { queryClient } from '../query-client';
+import { handleError } from '../utils/handle-error';
 import { getBackupOutcome } from '../utils/backup-status';
-import { createQuery } from '@tanstack/svelte-query';
+import { createMutation, createQuery } from '@tanstack/svelte-query';
 import { handleCreateBackup } from './repository.service';
 export const getBackupPageActions = (repositoryId, onConfigure) => {
     const Configure = {
@@ -31,6 +32,7 @@ export const immichBackupStatusKeys = {
 const invalidateImmichBackupStatus = () => void queryClient.invalidateQueries({
     queryKey: immichBackupStatusKeys.all,
 });
+const updateImmichBackupStatus = (update) => queryClient.setQueryData(immichBackupStatusKeys.all, (data) => data && update(data));
 export const useImmichBackupStatusEventHandler = () => ({
     onIntegrationUpdate: invalidateImmichBackupStatus,
     onRepositoryUpdate: invalidateImmichBackupStatus,
@@ -77,5 +79,28 @@ export const useImmichBackupStatus = () => {
         get status() {
             return toImmichBackupStatus(query.data, query.isLoading);
         },
+        get needsAttention() {
+            const usingImmichDbDump = query.data?.databaseDump?.enabled === true &&
+                query.data.schedule !== undefined &&
+                !query.data.schedule.paused &&
+                query.data.databaseDumpWarningIgnored !== true;
+            return usingImmichDbDump;
+        },
     };
 };
+export const useConfigureImmichDatabaseDump = () => createMutation(() => ({
+    mutationFn: (dto) => configureImmichDatabaseDump(dto),
+    onSuccess: (_, dto) => updateImmichBackupStatus((data) => ({
+        ...data,
+        databaseDump: data.databaseDump && { ...data.databaseDump, ...dto },
+    })),
+    onError: (error) => handleError(error, 'Failed to update Immich database dump settings'),
+}), () => queryClient);
+export const useIgnoreImmichDatabaseDumpWarning = () => createMutation(() => ({
+    mutationFn: () => ignoreImmichDatabaseDumpWarning(),
+    onSuccess: () => updateImmichBackupStatus((data) => ({
+        ...data,
+        databaseDumpWarningIgnored: true,
+    })),
+    onError: (error) => handleError(error, 'Failed to ignore Immich database dump warning'),
+}), () => queryClient);

package/package.json

@@ -2,7 +2,7 @@
   "name": "@futo-org/backups-orchestrator-ui",
   "repository": "https://github.com/immich-app/yucca",
   "description": "Backups orchestrator (UI library)",
-  "version": "0.45.0",
+  "version": "0.46.0",
   "license": "Source First License 1.1",
   "files": [
     "dist",
@@ -64,7 +64,7 @@
     "lodash.debounce": "^4.0.8",
     "luxon": "^3.7.2",
     "socket.io-client": "^4.8.3",
-    "@futo-org/backups-api-client": "^0.45.0"
+    "@futo-org/backups-api-client": "^0.46.0"
   },
   "scripts": {
     "dev": "vite dev --port 5174",