Skip to content

High performance self-hosted photo and video management solution.

refactor(web): tag service (#25142)

Jason Rasmussen8136d7fd545d
diff --git a/web/src/lib/managers/event-manager.svelte.ts b/web/src/lib/managers/event-manager.svelte.ts
index 8f1ff80607..ef4cc61daf 100644
--- a/web/src/lib/managers/event-manager.svelte.ts
+++ b/web/src/lib/managers/event-manager.svelte.ts
@@ -1,5 +1,6 @@
import type { ThemeSetting } from '$lib/managers/theme-manager.svelte';
import type { ReleaseEvent } from '$lib/types';
+import type { TreeNode } from '$lib/utils/tree-utils';
import type {
AlbumResponseDto,
ApiKeyResponseDto,
@@ -10,6 +11,7 @@ import type {
QueueResponseDto,
SharedLinkResponseDto,
SystemConfigDto,
+ TagResponseDto,
UserAdminResponseDto,
WorkflowResponseDto,
} from '@immich/sdk';
@@ -42,6 +44,10 @@ export type Events = {
SharedLinkUpdate: [SharedLinkResponseDto];
SharedLinkDelete: [SharedLinkResponseDto];
+ TagCreate: [TagResponseDto];
+ TagUpdate: [TagResponseDto];
+ TagDelete: [TreeNode];
+
UserAdminCreate: [UserAdminResponseDto];
UserAdminUpdate: [UserAdminResponseDto];
UserAdminRestore: [UserAdminResponseDto];
diff --git a/web/src/lib/modals/TagCreateModal.svelte b/web/src/lib/modals/TagCreateModal.svelte
index 5c48e83b08..268053a4cf 100644
--- a/web/src/lib/modals/TagCreateModal.svelte
+++ b/web/src/lib/modals/TagCreateModal.svelte
@@ -1,14 +1,12 @@
<script lang="ts">
- import SettingInputField from '$lib/components/shared-components/settings/setting-input-field.svelte';
- import { SettingInputFieldType } from '$lib/constants';
+ import { handleCreateTag } from '$lib/services/tag.service';
import type { TreeNode } from '$lib/utils/tree-utils';
- import { upsertTags, type TagResponseDto } from '@immich/sdk';
- import { Button, HStack, Modal, ModalBody, ModalFooter, toastManager } from '@immich/ui';
+ import { Field, FormModal, Input, Text } from '@immich/ui';
import { mdiTag } from '@mdi/js';
import { t } from 'svelte-i18n';
type Props = {
- onClose: (tag?: TagResponseDto) => void;
+ onClose: () => void;
baseTag?: TreeNode;
};
@@ -16,44 +14,17 @@
let tagValue = $state(baseTag?.path ? `${baseTag.path}/` : '');
- const createTag = async () => {
- const [tag] = await upsertTags({ tagUpsertDto: { tags: [tagValue] } });
-
- if (!tag) {
- return;
+ const onSubmit = async () => {
+ const success = await handleCreateTag(tagValue);
+ if (success) {
+ onClose();
}
-
- toastManager.success($t('tag_created', { values: { tag: tag.value } }));
-
- onClose(tag);
};
</script>
-<Modal size="small" title={$t('create_tag')} icon={mdiTag} {onClose}>
- <ModalBody>
- <div class="text-primary">
- <p class="text-sm dark:text-immich-dark-fg">
- {$t('create_tag_description')}
- </p>
- </div>
-
- <form onsubmit={createTag} autocomplete="off" id="create-tag-form">
- <div class="my-4 flex flex-col gap-2">
- <SettingInputField
- inputType={SettingInputFieldType.TEXT}
- label={$t('tag')}
- bind:value={tagValue}
- required={true}
- autofocus={true}
- />
- </div>
- </form>
- </ModalBody>
-
- <ModalFooter>
- <HStack fullWidth>
- <Button color="secondary" fullWidth shape="round" onclick={() => onClose()}>{$t('cancel')}</Button>
- <Button type="submit" fullWidth shape="round" form="create-tag-form">{$t('create')}</Button>
- </HStack>
- </ModalFooter>
-</Modal>
+<FormModal size="small" title={$t('create_tag')} submitText={$t('create')} icon={mdiTag} {onClose} {onSubmit}>
+ <Text size="small">{$t('create_tag_description')}</Text>
+ <Field label={$t('tag')} required>
+ <Input autofocus bind:value={tagValue} />
+ </Field>
+</FormModal>
diff --git a/web/src/lib/modals/TagEditModal.svelte b/web/src/lib/modals/TagEditModal.svelte
index 40c8655d5e..14a137a16a 100644
--- a/web/src/lib/modals/TagEditModal.svelte
+++ b/web/src/lib/modals/TagEditModal.svelte
@@ -1,47 +1,29 @@
<script lang="ts">
import SettingInputField from '$lib/components/shared-components/settings/setting-input-field.svelte';
import { SettingInputFieldType } from '$lib/constants';
+ import { handleUpdateTag } from '$lib/services/tag.service';
import type { TreeNode } from '$lib/utils/tree-utils';
- import { updateTag, type TagResponseDto } from '@immich/sdk';
- import { Button, HStack, Modal, ModalBody, ModalFooter, toastManager } from '@immich/ui';
+ import { FormModal } from '@immich/ui';
import { mdiTag } from '@mdi/js';
import { t } from 'svelte-i18n';
type Props = {
tag: TreeNode;
- onClose: (updatedTag?: TagResponseDto) => void;
+ onClose: () => void;
};
const { tag, onClose }: Props = $props();
let tagColor = $state(tag.color ?? '');
- const handleEdit = async () => {
- if (!tag.id) {
- return;
+ const onSubmit = async () => {
+ const success = await handleUpdateTag(tag, { color: tagColor });
+ if (success) {
+ onClose();
}
-
- const updatedTag = await updateTag({ id: tag.id, tagUpdateDto: { color: tagColor } });
-
- toastManager.success($t('tag_updated', { values: { tag: tag.value } }));
-
- onClose(updatedTag);
};
</script>
-<Modal title={$t('edit_tag')} icon={mdiTag} {onClose}>
- <ModalBody>
- <form onsubmit={handleEdit} autocomplete="off" id="edit-tag-form">
- <div class="my-4 flex flex-col gap-2">
- <SettingInputField inputType={SettingInputFieldType.COLOR} label={$t('color')} bind:value={tagColor} />
- </div>
- </form>
- </ModalBody>
-
- <ModalFooter>
- <HStack fullWidth>
- <Button color="secondary" fullWidth shape="round" onclick={() => onClose()}>{$t('cancel')}</Button>
- <Button type="submit" fullWidth shape="round" form="edit-tag-form">{$t('save')}</Button>
- </HStack>
- </ModalFooter>
-</Modal>
+<FormModal title={$t('edit_tag')} size="small" icon={mdiTag} {onClose} {onSubmit}>
+ <SettingInputField inputType={SettingInputFieldType.COLOR} label={$t('color')} bind:value={tagColor} />
+</FormModal>
diff --git a/web/src/lib/services/tag.service.ts b/web/src/lib/services/tag.service.ts
new file mode 100644
index 0000000000..bbdc843c46
--- /dev/null
+++ b/web/src/lib/services/tag.service.ts
@@ -0,0 +1,98 @@
+import { eventManager } from '$lib/managers/event-manager.svelte';
+import TagCreateModal from '$lib/modals/TagCreateModal.svelte';
+import TagEditModal from '$lib/modals/TagEditModal.svelte';
+import { handleError } from '$lib/utils/handle-error';
+import { getFormatter } from '$lib/utils/i18n';
+import type { TreeNode } from '$lib/utils/tree-utils';
+import { deleteTag, updateTag, upsertTags, type TagUpdateDto } from '@immich/sdk';
+import { modalManager, toastManager, type ActionItem } from '@immich/ui';
+import { mdiPencil, mdiPlus, mdiTrashCanOutline } from '@mdi/js';
+import { type MessageFormatter } from 'svelte-i18n';
+
+export const getTagActions = ($t: MessageFormatter, tag: TreeNode) => {
+ const Create: ActionItem = {
+ title: $t('create_tag'),
+ icon: mdiPlus,
+ onAction: () => modalManager.show(TagCreateModal, { baseTag: tag }),
+ };
+
+ const Update: ActionItem = {
+ title: $t('edit_tag'),
+ icon: mdiPencil,
+ $if: () => tag.path.length > 0,
+ onAction: () => modalManager.show(TagEditModal, { tag }),
+ };
+
+ const Delete: ActionItem = {
+ title: $t('delete_tag'),
+ icon: mdiTrashCanOutline,
+ $if: () => tag.path.length > 0,
+ onAction: () => handleDeleteTag(tag),
+ };
+
+ return { Create, Update, Delete };
+};
+
+export const handleCreateTag = async (tagValue: string) => {
+ const $t = await getFormatter();
+
+ try {
+ const [tag] = await upsertTags({ tagUpsertDto: { tags: [tagValue] } });
+ if (!tag) {
+ return;
+ }
+
+ toastManager.success($t('tag_created', { values: { tag: tag.value } }));
+ eventManager.emit('TagCreate', tag);
+
+ return true;
+ } catch (error) {
+ handleError(error, $t('errors.something_went_wrong'));
+ }
+};
+
+export const handleUpdateTag = async (tag: TreeNode, dto: TagUpdateDto) => {
+ const $t = await getFormatter();
+
+ if (!tag.id) {
+ return;
+ }
+
+ try {
+ const response = await updateTag({ id: tag.id, tagUpdateDto: dto });
+
+ toastManager.success($t('tag_updated', { values: { tag: tag.value } }));
+ eventManager.emit('TagUpdate', response);
+
+ return true;
+ } catch (error) {
+ handleError(error, $t('errors.something_went_wrong'));
+ }
+};
+
+const handleDeleteTag = async (tag: TreeNode) => {
+ const $t = await getFormatter();
+
+ const tagId = tag.id;
+ if (!tagId) {
+ return;
+ }
+
+ const confirmed = await modalManager.showDialog({
+ title: $t('delete_tag'),
+ prompt: $t('delete_tag_confirmation_prompt', { values: { tagName: tag.value } }),
+ confirmText: $t('delete'),
+ });
+
+ if (!confirmed) {
+ return;
+ }
+
+ try {
+ await deleteTag({ id: tagId });
+ eventManager.emit('TagDelete', tag);
+ toastManager.success();
+ } catch (error) {
+ handleError(error, $t('errors.something_went_wrong'));
+ }
+};
diff --git a/web/src/routes/(user)/tags/[[photos=photos]]/[[assetId=id]]/+page.svelte b/web/src/routes/(user)/tags/[[photos=photos]]/[[assetId=id]]/+page.svelte
index 7f873aa918..4d163f78ed 100644
--- a/web/src/routes/(user)/tags/[[photos=photos]]/[[assetId=id]]/+page.svelte
+++ b/web/src/routes/(user)/tags/[[photos=photos]]/[[assetId=id]]/+page.svelte
@@ -1,24 +1,14 @@
<script lang="ts">
import { goto } from '$app/navigation';
+ import OnEvents from '$lib/components/OnEvents.svelte';
import UserPageLayout, { headerId } from '$lib/components/layouts/user-page-layout.svelte';
+ import ButtonContextMenu from '$lib/components/shared-components/context-menu/button-context-menu.svelte';
import Breadcrumbs from '$lib/components/shared-components/tree/breadcrumbs.svelte';
import TreeItemThumbnails from '$lib/components/shared-components/tree/tree-item-thumbnails.svelte';
import TreeItems from '$lib/components/shared-components/tree/tree-items.svelte';
import Sidebar from '$lib/components/sidebar/sidebar.svelte';
- import Timeline from '$lib/components/timeline/Timeline.svelte';
- import { AppRoute, AssetAction, QueryParameter } from '$lib/constants';
- import SkipLink from '$lib/elements/SkipLink.svelte';
- import { TimelineManager } from '$lib/managers/timeline-manager/timeline-manager.svelte';
- import TagCreateModal from '$lib/modals/TagCreateModal.svelte';
- import TagEditModal from '$lib/modals/TagEditModal.svelte';
- import { AssetInteraction } from '$lib/stores/asset-interaction.svelte';
- import { joinPaths, TreeNode } from '$lib/utils/tree-utils';
- import { deleteTag, getAllTags, type TagResponseDto } from '@immich/sdk';
- import { Button, HStack, modalManager, Text } from '@immich/ui';
- import { mdiDotsVertical, mdiPencil, mdiPlus, mdiTag, mdiTagMultiple, mdiTrashCanOutline } from '@mdi/js';
- import { t } from 'svelte-i18n';
- import type { PageData } from './$types';
import AssetSelectControlBar from '$lib/components/timeline/AssetSelectControlBar.svelte';
+ import Timeline from '$lib/components/timeline/Timeline.svelte';
import AddToAlbum from '$lib/components/timeline/actions/AddToAlbumAction.svelte';
import ArchiveAction from '$lib/components/timeline/actions/ArchiveAction.svelte';
import ChangeDate from '$lib/components/timeline/actions/ChangeDateAction.svelte';
@@ -31,8 +21,17 @@
import SelectAllAssets from '$lib/components/timeline/actions/SelectAllAction.svelte';
import SetVisibilityAction from '$lib/components/timeline/actions/SetVisibilityAction.svelte';
import TagAction from '$lib/components/timeline/actions/TagAction.svelte';
- import ButtonContextMenu from '$lib/components/shared-components/context-menu/button-context-menu.svelte';
+ import { AppRoute, AssetAction, QueryParameter } from '$lib/constants';
+ import SkipLink from '$lib/elements/SkipLink.svelte';
+ import { TimelineManager } from '$lib/managers/timeline-manager/timeline-manager.svelte';
+ import { getTagActions } from '$lib/services/tag.service';
+ import { AssetInteraction } from '$lib/stores/asset-interaction.svelte';
import { preferences, user } from '$lib/stores/user.store';
+ import { joinPaths, TreeNode } from '$lib/utils/tree-utils';
+ import { getAllTags, type TagResponseDto } from '@immich/sdk';
+ import { mdiDotsVertical, mdiPlus, mdiTag, mdiTagMultiple } from '@mdi/js';
+ import { t } from 'svelte-i18n';
+ import type { PageData } from './$types';
interface Props {
data: PageData;
@@ -59,49 +58,29 @@
const navigateToView = (path: string) => goto(getLink(path));
- const handleCreate = async () => {
- await modalManager.show(TagCreateModal, { baseTag: tag });
- tags = await getAllTags();
+ const handleSetVisibility = (assetIds: string[]) => {
+ timelineManager.removeAssets(assetIds);
+ assetInteraction.clearMultiselect();
};
- const handleEdit = async () => {
- if (!tag) {
- return;
- }
-
- await modalManager.show(TagEditModal, { tag });
+ const onRefresh = async () => {
tags = await getAllTags();
};
- const handleDelete = async () => {
- if (!tag) {
- return;
- }
-
- const isConfirm = await modalManager.showDialog({
- title: $t('delete_tag'),
- prompt: $t('delete_tag_confirmation_prompt', { values: { tagName: tag.value } }),
- confirmText: $t('delete'),
- });
-
- if (!isConfirm) {
- return;
+ const onTagDelete = async (response: TreeNode) => {
+ if (response.path === tag.path) {
+ await navigateToView(tag.parent ? tag.parent.path : '');
}
- await deleteTag({ id: tag.id! });
- tags = await getAllTags();
-
- // navigate to parent
- await navigateToView(tag.parent ? tag.parent.path : '');
+ await onRefresh();
};
- const handleSetVisibility = (assetIds: string[]) => {
- timelineManager.removeAssets(assetIds);
- assetInteraction.clearMultiselect();
- };
+ const { Create, Update, Delete } = $derived(getTagActions($t, tag));
</script>
-<UserPageLayout title={data.meta.title}>
+<OnEvents onTagCreate={onRefresh} onTagUpdate={onRefresh} {onTagDelete} />
+
+<UserPageLayout title={data.meta.title} actions={[Create, Update, Delete]}>
{#snippet sidebar()}
<Sidebar>
<SkipLink target={`#${headerId}`} text={$t('skip_to_tags')} breakpoint="md" />
@@ -114,23 +93,6 @@
</Sidebar>
{/snippet}
- {#snippet buttons()}
- <HStack>
- <Button leadingIcon={mdiPlus} onclick={handleCreate} size="small" variant="ghost" color="secondary">
- <Text class="hidden md:block">{$t('create_tag')}</Text>
- </Button>
-
- {#if tag.path.length > 0}
- <Button leadingIcon={mdiPencil} onclick={handleEdit} size="small" variant="ghost" color="secondary">
- <Text class="hidden md:block">{$t('edit_tag')}</Text>
- </Button>
- <Button leadingIcon={mdiTrashCanOutline} onclick={handleDelete} size="small" variant="ghost" color="secondary">
- <Text class="hidden md:block">{$t('delete_tag')}</Text>
- </Button>
- {/if}
- </HStack>
- {/snippet}
-
<Breadcrumbs node={tag} icon={mdiTagMultiple} title={$t('tags')} {getLink} />
<section class="mt-2 h-[calc(100%-(--spacing(20)))] overflow-auto immich-scrollbar">