Skip to content

High performance self-hosted photo and video management solution.

chore: more flexible modal manager types (#19123)

Daniel Dietzler22eef5f3c5d5
diff --git a/web/src/lib/components/admin-page/settings/auth/auth-settings.svelte b/web/src/lib/components/admin-page/settings/auth/auth-settings.svelte
index d7af26688a..a5384e9b41 100644
--- a/web/src/lib/components/admin-page/settings/auth/auth-settings.svelte
+++ b/web/src/lib/components/admin-page/settings/auth/auth-settings.svelte
@@ -36,7 +36,7 @@
const handleSave = async (skipConfirm: boolean) => {
const allMethodsDisabled = !config.oauth.enabled && !config.passwordLogin.enabled;
if (allMethodsDisabled && !skipConfirm) {
- const isConfirmed = await modalManager.show(AuthDisableLoginConfirmModal, {});
+ const isConfirmed = await modalManager.show(AuthDisableLoginConfirmModal);
if (!isConfirmed) {
return;
}
diff --git a/web/src/lib/components/asset-viewer/slideshow-bar.svelte b/web/src/lib/components/asset-viewer/slideshow-bar.svelte
index 135da12d26..0bb81ea44b 100644
--- a/web/src/lib/components/asset-viewer/slideshow-bar.svelte
+++ b/web/src/lib/components/asset-viewer/slideshow-bar.svelte
@@ -104,7 +104,7 @@
if (document.fullscreenElement) {
await document.exitFullscreen();
}
- await modalManager.show(SlideshowSettingsModal, {});
+ await modalManager.show(SlideshowSettingsModal);
};
</script>
diff --git a/web/src/lib/components/photos-page/actions/change-description-action.svelte b/web/src/lib/components/photos-page/actions/change-description-action.svelte
index 129d327fb9..740bed78ef 100644
--- a/web/src/lib/components/photos-page/actions/change-description-action.svelte
+++ b/web/src/lib/components/photos-page/actions/change-description-action.svelte
@@ -18,7 +18,7 @@
const { clearSelect, getOwnedAssets } = getAssetControlContext();
const handleUpdateDescription = async () => {
- const description = await modalManager.show(AssetUpdateDecriptionConfirmModal, {});
+ const description = await modalManager.show(AssetUpdateDecriptionConfirmModal);
if (description) {
const ids = getSelectedAssets(getOwnedAssets(), $user);
diff --git a/web/src/lib/components/photos-page/asset-grid.svelte b/web/src/lib/components/photos-page/asset-grid.svelte
index 2dd9ef3ac7..ce2b1ca096 100644
--- a/web/src/lib/components/photos-page/asset-grid.svelte
+++ b/web/src/lib/components/photos-page/asset-grid.svelte
@@ -703,7 +703,7 @@
}
isShortcutModalOpen = true;
- await modalManager.show(ShortcutsModal, {});
+ await modalManager.show(ShortcutsModal);
isShortcutModalOpen = false;
};
diff --git a/web/src/lib/components/shared-components/gallery-viewer/gallery-viewer.svelte b/web/src/lib/components/shared-components/gallery-viewer/gallery-viewer.svelte
index 1c4d888cb8..09998ed060 100644
--- a/web/src/lib/components/shared-components/gallery-viewer/gallery-viewer.svelte
+++ b/web/src/lib/components/shared-components/gallery-viewer/gallery-viewer.svelte
@@ -5,11 +5,10 @@
import Thumbnail from '$lib/components/assets/thumbnail/thumbnail.svelte';
import { AppRoute, AssetAction } from '$lib/constants';
import { modalManager } from '$lib/managers/modal-manager.svelte';
+ import type { TimelineAsset, Viewport } from '$lib/managers/timeline-manager/types';
import ShortcutsModal from '$lib/modals/ShortcutsModal.svelte';
import type { AssetInteraction } from '$lib/stores/asset-interaction.svelte';
import { assetViewingStore } from '$lib/stores/asset-viewing.store';
- import type { TimelineAsset } from '$lib/managers/timeline-manager/types';
- import type { Viewport } from '$lib/managers/timeline-manager/types';
import { showDeleteModal } from '$lib/stores/preferences.store';
import { featureFlags } from '$lib/stores/server-config.store';
import { handlePromiseError } from '$lib/utils';
diff --git a/web/src/lib/components/shared-components/navigation-bar/account-info-panel.svelte b/web/src/lib/components/shared-components/navigation-bar/account-info-panel.svelte
index 40ae672e0c..b079ecb241 100644
--- a/web/src/lib/components/shared-components/navigation-bar/account-info-panel.svelte
+++ b/web/src/lib/components/shared-components/navigation-bar/account-info-panel.svelte
@@ -51,7 +51,7 @@
shape="round"
onclick={async () => {
onClose();
- await modalManager.show(AvatarEditModal, {});
+ await modalManager.show(AvatarEditModal);
}}
/>
</div>
diff --git a/web/src/lib/components/shared-components/side-bar/purchase-info.svelte b/web/src/lib/components/shared-components/side-bar/purchase-info.svelte
index 665c620563..5a984e94be 100644
--- a/web/src/lib/components/shared-components/side-bar/purchase-info.svelte
+++ b/web/src/lib/components/shared-components/side-bar/purchase-info.svelte
@@ -27,7 +27,7 @@
const { isPurchased } = purchaseStore;
const openPurchaseModal = async () => {
- await modalManager.show(PurchaseModal, {});
+ await modalManager.show(PurchaseModal);
showMessage = false;
};
diff --git a/web/src/lib/managers/modal-manager.svelte.ts b/web/src/lib/managers/modal-manager.svelte.ts
index 46363a105b..f5612d072d 100644
--- a/web/src/lib/managers/modal-manager.svelte.ts
+++ b/web/src/lib/managers/modal-manager.svelte.ts
@@ -6,15 +6,21 @@ type OnCloseData<T> = T extends { onClose: (data?: infer R) => void }
: T extends { onClose: (data: infer R) => void }
? R
: never;
-type ExtendsEmptyObject<T> = keyof T extends never ? Record<string, never> : T;
+type ExtendsEmptyObject<T> = keyof T extends never ? never : T;
type StripValueIfOptional<T> = T extends undefined ? undefined : T;
+// if the modal does not expect any props, makes the props param optional but also allows passing `{}` and `undefined`
+type OptionalParamIfEmpty<T> = ExtendsEmptyObject<T> extends never ? [] | [Record<string, never> | undefined] : [T];
+
class ModalManager {
- show<T extends object>(Component: Component<T>, props: ExtendsEmptyObject<Omit<T, 'onClose'>>) {
- return this.open(Component, props).onClose;
+ show<T extends object>(Component: Component<T>, ...props: OptionalParamIfEmpty<Omit<T, 'onClose'>>) {
+ return this.open(Component, ...props).onClose;
}
- open<T extends object, K = OnCloseData<T>>(Component: Component<T>, props: ExtendsEmptyObject<Omit<T, 'onClose'>>) {
+ open<T extends object, K = OnCloseData<T>>(
+ Component: Component<T>,
+ ...props: OptionalParamIfEmpty<Omit<T, 'onClose'>>
+ ) {
let modal: object = {};
let onClose: (...args: [StripValueIfOptional<K>]) => Promise<void>;
@@ -27,7 +33,7 @@ class ModalManager {
modal = mount(Component, {
target: document.body,
props: {
- ...(props as T),
+ ...((props?.[0] ?? {}) as T),
onClose,
},
});
diff --git a/web/src/routes/(user)/utilities/duplicates/[[photos=photos]]/[[assetId=id]]/+page.svelte b/web/src/routes/(user)/utilities/duplicates/[[photos=photos]]/[[assetId=id]]/+page.svelte
index 22fc8dac01..42da091997 100644
--- a/web/src/routes/(user)/utilities/duplicates/[[photos=photos]]/[[assetId=id]]/+page.svelte
+++ b/web/src/routes/(user)/utilities/duplicates/[[photos=photos]]/[[assetId=id]]/+page.svelte
@@ -200,7 +200,7 @@
icon={mdiInformationOutline}
aria-label={$t('deduplication_info')}
size="small"
- onclick={() => modalManager.show(DuplicatesInformationModal, {})}
+ onclick={() => modalManager.show(DuplicatesInformationModal)}
/>
</div>
diff --git a/web/src/routes/admin/library-management/+page.svelte b/web/src/routes/admin/library-management/+page.svelte
index 450e0d8c8d..3d8792749c 100644
--- a/web/src/routes/admin/library-management/+page.svelte
+++ b/web/src/routes/admin/library-management/+page.svelte
@@ -207,7 +207,7 @@
};
const onCreateNewLibraryClicked = async () => {
- const result = await modalManager.show(LibraryUserPickerModal, {});
+ const result = await modalManager.show(LibraryUserPickerModal);
if (result) {
await handleCreate(result);
}
diff --git a/web/src/routes/admin/users/+page.svelte b/web/src/routes/admin/users/+page.svelte
index 87846b9542..3ebc67dabf 100644
--- a/web/src/routes/admin/users/+page.svelte
+++ b/web/src/routes/admin/users/+page.svelte
@@ -58,7 +58,7 @@
};
const handleCreate = async () => {
- await modalManager.show(UserCreateModal, {});
+ await modalManager.show(UserCreateModal);
await refresh();
};