feat: Added shortcuts, shift-multi select and missing menu options to Search (Galleryviewer) (#14213)

feat: Added shortcuts, shift-multi select and missing menu options to GalleryViewer (Search, Share, Memories)

Co-authored-by: Alex <alex.tran1502@gmail.com>

web/src/lib/components/shared-components/gallery-viewer/gallery-viewer.svelte

@@ -1,50 +1,63 @@
 <script lang="ts">
+  import { shortcuts, type ShortcutOptions } from '$lib/actions/shortcut';
   import { goto } from '$app/navigation';
   import type { Action } from '$lib/components/asset-viewer/actions/action';
   import Thumbnail from '$lib/components/assets/thumbnail/thumbnail.svelte';
   import { AppRoute, AssetAction } from '$lib/constants';
   import { assetViewingStore } from '$lib/stores/asset-viewing.store';
+  import type { AssetInteractionStore } from '$lib/stores/asset-interaction.store';
   import type { Viewport } from '$lib/stores/assets.store';
-  import { getAssetRatio } from '$lib/utils/asset-utils';
+  import { showDeleteModal } from '$lib/stores/preferences.store';
+  import { deleteAssets } from '$lib/utils/actions';
+  import { archiveAssets, cancelMultiselect, getAssetRatio } from '$lib/utils/asset-utils';
+  import { featureFlags } from '$lib/stores/server-config.store';
   import { handleError } from '$lib/utils/handle-error';
   import { navigate } from '$lib/utils/navigation';
   import { calculateWidth } from '$lib/utils/timeline-util';
   import { type AssetResponseDto } from '@immich/sdk';
   import justifiedLayout from 'justified-layout';
-  import { onDestroy } from 'svelte';
   import { t } from 'svelte-i18n';
   import AssetViewer from '../../asset-viewer/asset-viewer.svelte';
+  import ShowShortcuts from '../show-shortcuts.svelte';
   import Portal from '../portal/portal.svelte';
   import { handlePromiseError } from '$lib/utils';
+  import DeleteAssetDialog from '../../photos-page/delete-asset-dialog.svelte';
 
   interface Props {
     assets: AssetResponseDto[];
-    selectedAssets?: Set<AssetResponseDto>;
+    assetInteractionStore: AssetInteractionStore;
     disableAssetSelect?: boolean;
     showArchiveIcon?: boolean;
     viewport: Viewport;
     onIntersected?: (() => void) | undefined;
     showAssetName?: boolean;
+    isShowDeleteConfirmation?: boolean;
     onPrevious?: (() => Promise<AssetResponseDto | undefined>) | undefined;
     onNext?: (() => Promise<AssetResponseDto | undefined>) | undefined;
   }
 
   let {
     assets = $bindable(),
-    selectedAssets = $bindable(new Set()),
+    assetInteractionStore = $bindable(),
     disableAssetSelect = false,
     showArchiveIcon = false,
     viewport,
     onIntersected = undefined,
     showAssetName = false,
+    isShowDeleteConfirmation = $bindable(false),
     onPrevious = undefined,
     onNext = undefined,
   }: Props = $props();
 
   let { isViewing: isViewerOpen, asset: viewingAsset, setAsset } = assetViewingStore;
 
+  const { assetSelectionCandidates, assetSelectionStart, selectedAssets, isMultiSelectState } = assetInteractionStore;
+
+  let showShortcuts = $state(false);
   let currentViewAssetIndex = 0;
-  let isMultiSelectionMode = $derived(selectedAssets.size > 0);
+  let isMultiSelectionMode = $derived($selectedAssets.size > 0);
+  let shiftKeyIsDown = $state(false);
+  let lastAssetMouseEvent: AssetResponseDto | null = $state(null);
 
   const viewAssetHandler = async (asset: AssetResponseDto) => {
     currentViewAssetIndex = assets.findIndex((a) => a.id == asset.id);
@@ -52,18 +65,146 @@
     await navigate({ targetRoute: 'current', assetId: $viewingAsset.id });
   };
 
-  const selectAssetHandler = (asset: AssetResponseDto) => {
-    let temporary = new Set(selectedAssets);
+  const selectAllAssets = () => {
+    assetInteractionStore.selectAssets(assets);
+  };
 
-    if (selectedAssets.has(asset)) {
-      temporary.delete(asset);
+  const deselectAllAssets = () => {
+    cancelMultiselect(assetInteractionStore);
+  };
+
+  const onKeyDown = (event: KeyboardEvent) => {
+    if (event.key === 'Shift') {
+      event.preventDefault();
+      shiftKeyIsDown = true;
+    }
+  };
+
+  const onKeyUp = (event: KeyboardEvent) => {
+    if (event.key === 'Shift') {
+      event.preventDefault();
+      shiftKeyIsDown = false;
+    }
+  };
+
+  const handleSelectAssets = (asset: AssetResponseDto) => {
+    if (!asset) {
+      return;
+    }
+    const deselect = $selectedAssets.has(asset);
+
+    // Select/deselect already loaded assets
+    if (deselect) {
+      for (const candidate of $assetSelectionCandidates || []) {
+        assetInteractionStore.removeAssetFromMultiselectGroup(candidate);
+      }
+      assetInteractionStore.removeAssetFromMultiselectGroup(asset);
     } else {
-      temporary.add(asset);
+      for (const candidate of $assetSelectionCandidates || []) {
+        assetInteractionStore.selectAsset(candidate);
+      }
+      assetInteractionStore.selectAsset(asset);
     }
 
-    selectedAssets = temporary;
+    assetInteractionStore.clearAssetSelectionCandidates();
+    assetInteractionStore.setAssetSelectionStart(deselect ? null : asset);
   };
 
+  const handleSelectAssetCandidates = (asset: AssetResponseDto | null) => {
+    if (asset) {
+      selectAssetCandidates(asset);
+    }
+    lastAssetMouseEvent = asset;
+  };
+
+  const selectAssetCandidates = (endAsset: AssetResponseDto) => {
+    if (!shiftKeyIsDown) {
+      return;
+    }
+
+    const startAsset = $assetSelectionStart;
+    if (!startAsset) {
+      return;
+    }
+
+    let start = assets.findIndex((a) => a.id === startAsset.id);
+    let end = assets.findIndex((a) => a.id === endAsset.id);
+
+    if (start > end) {
+      [start, end] = [end, start];
+    }
+
+    assetInteractionStore.setAssetSelectionCandidates(assets.slice(start, end + 1));
+  };
+
+  const onSelectStart = (e: Event) => {
+    if ($isMultiSelectState && shiftKeyIsDown) {
+      e.preventDefault();
+    }
+  };
+
+  const onDelete = () => {
+    const hasTrashedAsset = Array.from($selectedAssets).some((asset) => asset.isTrashed);
+
+    if ($showDeleteModal && (!isTrashEnabled || hasTrashedAsset)) {
+      isShowDeleteConfirmation = true;
+      return;
+    }
+    handlePromiseError(trashOrDelete(hasTrashedAsset));
+  };
+
+  const onForceDelete = () => {
+    if ($showDeleteModal) {
+      isShowDeleteConfirmation = true;
+      return;
+    }
+    handlePromiseError(trashOrDelete(true));
+  };
+
+  const trashOrDelete = async (force: boolean = false) => {
+    isShowDeleteConfirmation = false;
+    await deleteAssets(
+      !(isTrashEnabled && !force),
+      (assetIds) => (assets = assets.filter((asset) => !assetIds.includes(asset.id))),
+      idsSelectedAssets,
+    );
+    assetInteractionStore.clearMultiselect();
+  };
+
+  const toggleArchive = async () => {
+    const ids = await archiveAssets(Array.from($selectedAssets), !isAllArchived);
+    if (ids) {
+      assets.filter((asset) => !ids.includes(asset.id));
+      deselectAllAssets();
+    }
+  };
+
+  let shortcutList = $derived(
+    (() => {
+      if ($isViewerOpen) {
+        return [];
+      }
+
+      const shortcuts: ShortcutOptions[] = [
+        { shortcut: { key: '?', shift: true }, onShortcut: () => (showShortcuts = !showShortcuts) },
+        { shortcut: { key: '/' }, onShortcut: () => goto(AppRoute.EXPLORE) },
+        { shortcut: { key: 'A', ctrl: true }, onShortcut: () => selectAllAssets() },
+      ];
+
+      if ($isMultiSelectState) {
+        shortcuts.push(
+          { shortcut: { key: 'Escape' }, onShortcut: deselectAllAssets },
+          { shortcut: { key: 'Delete' }, onShortcut: onDelete },
+          { shortcut: { key: 'Delete', shift: true }, onShortcut: onForceDelete },
+          { shortcut: { key: 'D', ctrl: true }, onShortcut: () => deselectAllAssets() },
+          { shortcut: { key: 'a', shift: true }, onShortcut: toggleArchive },
+        );
+      }
+
+      return shortcuts;
+    })(),
+  );
+
   const handleNext = async () => {
     try {
       let asset: AssetResponseDto | undefined;
@@ -124,9 +265,15 @@
     }
   };
 
-  onDestroy(() => {
-    $isViewerOpen = false;
-  });
+  const assetMouseEventHandler = (asset: AssetResponseDto | null) => {
+    if ($isMultiSelectState) {
+      handleSelectAssetCandidates(asset);
+    }
+  };
+
+  let isTrashEnabled = $derived($featureFlags.loaded && $featureFlags.trash);
+  let idsSelectedAssets = $derived([...$selectedAssets].map(({ id }) => id));
+  let isAllArchived = $derived([...$selectedAssets].every((asset) => asset.isArchived));
 
   let geometry = $derived(
     (() => {
@@ -147,8 +294,40 @@
       };
     })(),
   );
+
+  $effect(() => {
+    if (!lastAssetMouseEvent) {
+      assetInteractionStore.clearAssetSelectionCandidates();
+    }
+  });
+
+  $effect(() => {
+    if (!shiftKeyIsDown) {
+      assetInteractionStore.clearAssetSelectionCandidates();
+    }
+  });
+
+  $effect(() => {
+    if (shiftKeyIsDown && lastAssetMouseEvent) {
+      selectAssetCandidates(lastAssetMouseEvent);
+    }
+  });
 </script>
 
+<svelte:window onkeydown={onKeyDown} onkeyup={onKeyUp} onselectstart={onSelectStart} use:shortcuts={shortcutList} />
+
+{#if isShowDeleteConfirmation}
+  <DeleteAssetDialog
+    size={idsSelectedAssets.length}
+    onCancel={() => (isShowDeleteConfirmation = false)}
+    onConfirm={() => handlePromiseError(trashOrDelete(true))}
+  />
+{/if}
+
+{#if showShortcuts}
+  <ShowShortcuts onClose={() => (showShortcuts = !showShortcuts)} />
+{/if}
+
 {#if assets.length > 0}
   <div class="relative" style="height: {geometry.containerHeight}px;width: {geometry.containerWidth}px ">
     {#each assets as asset, i (i)}
@@ -159,19 +338,21 @@
         title={showAssetName ? asset.originalFileName : ''}
       >
         <Thumbnail
-          {asset}
           readonly={disableAssetSelect}
           onClick={(asset) => {
             if (isMultiSelectionMode) {
-              selectAssetHandler(asset);
+              handleSelectAssets(asset);
               return;
             }
             void viewAssetHandler(asset);
           }}
-          onSelect={(asset) => selectAssetHandler(asset)}
+          onSelect={(asset) => handleSelectAssets(asset)}
+          onMouseEvent={() => assetMouseEventHandler(asset)}
           onIntersected={() => (i === Math.max(1, assets.length - 7) ? onIntersected?.() : void 0)}
-          selected={selectedAssets.has(asset)}
           {showArchiveIcon}
+          {asset}
+          selected={$selectedAssets.has(asset)}
+          selectionCandidate={$assetSelectionCandidates.has(asset)}
           thumbnailWidth={geometry.boxes[i].width}
           thumbnailHeight={geometry.boxes[i].height}
         />