Skip to content

A self-hosted media server and file management system

feat: use types for image editor props

aminnausin67803c47e4f4
diff --git a/resources/js/components/modals/EditFolderImagesModal.vue b/resources/js/components/modals/EditFolderImagesModal.vue
new file mode 100644
index 00000000..7fd0def0
--- /dev/null
+++ b/resources/js/components/modals/EditFolderImagesModal.vue
@@ -0,0 +1,65 @@
+<script setup lang="ts">
+import type { SeriesImageEditorProps } from '@/types/modals';
+import type { SeriesResource } from '@/types/resources';
+
+import { updateSeriesImage } from '@/service/mediaAPI';
+import { useContentStore } from '@/stores/ContentStore';
+import { useQueryClient } from '@tanstack/vue-query';
+import { useModalStore } from '@/stores/ModalStore';
+import { BaseModal } from '@/components/cedar-ui/modal';
+
+import EditItemHeader from '@/components/headers/EditItemHeader.vue';
+import EditImages from '@/components/forms/EditImages.vue';
+
+const { updateFolderData } = useContentStore();
+
+const queryClient = useQueryClient();
+
+const modal = useModalStore();
+const modalProps = modal.getProps<SeriesImageEditorProps>();
+
+const handleSeriesUpdate = (data: SeriesResource) => {
+ updateFolderData(data);
+ modal.close();
+
+ invalidateQueries();
+};
+
+const invalidateQueries = async () => {
+ try {
+ if (!modalProps.queryKeys) return;
+ const QueriesToInvalidate: string[][] = modalProps.queryKeys;
+
+ QueriesToInvalidate.forEach(async (query) => {
+ await queryClient.invalidateQueries({
+ queryKey: query,
+ });
+ });
+ } catch (error) {
+ console.log('Failed to invalidate queries after updating a folder.', error);
+ }
+};
+</script>
+
+<template>
+ <BaseModal>
+ <template #title>{{ modalProps.title ?? 'Edit Images' }}</template>
+ <template #description>
+ <p>{{ modalProps.resource.title ?? 'Resource' }} · {{ modalProps.images?.length ?? 0 }} images</p>
+ <EditItemHeader
+ v-if="modalProps.resource.edited_at && modalProps.resource.editor_id"
+ :edited_at="modalProps.resource.edited_at"
+ :editor_id="modalProps.resource.editor_id"
+ />
+ </template>
+ <EditImages
+ :filters="['poster', 'preview']"
+ :readOnlyTypes="['preview']"
+ :primary-ids="{ poster: modalProps.resource.poster_image?.id }"
+ :images="modalProps.images"
+ :is-audio="modalProps.isMajorityAudio"
+ :submit-fn="(formData) => updateSeriesImage(modalProps.resource.id, formData)"
+ @handleFinish="handleSeriesUpdate"
+ />
+ </BaseModal>
+</template>
diff --git a/resources/js/components/modals/EditMediaImagesModal.vue b/resources/js/components/modals/EditMediaImagesModal.vue
index acd20937..2e59137b 100644
--- a/resources/js/components/modals/EditMediaImagesModal.vue
+++ b/resources/js/components/modals/EditMediaImagesModal.vue
@@ -1,14 +1,20 @@
<script setup lang="ts">
+import type { MediaImageEditorProps } from '@/types/modals';
import type { VideoResource } from '@/types/resources';
+import { updateMediaImage } from '@/service/mediaAPI';
import { useContentStore } from '@/stores/ContentStore';
import { useModalStore } from '@/stores/ModalStore';
import { BaseModal } from '@/components/cedar-ui/modal';
+import { MediaType } from '@/types/types';
+import EditItemHeader from '@/components/headers/EditItemHeader.vue';
import EditImages from '@/components/forms/EditImages.vue';
const { updateVideoData } = useContentStore();
+
const modal = useModalStore();
+const modalProps = modal.getProps<MediaImageEditorProps>();
const handleVideoDetailsUpdate = (data: VideoResource) => {
updateVideoData(data);
@@ -18,10 +24,24 @@ const handleVideoDetailsUpdate = (data: VideoResource) => {
<template>
<BaseModal>
- <template #title>{{ modal.props.title ?? 'Edit Images' }}</template>
- <template #description v-if="modal.props.resource">
- <p>{{ modal.props.resource.title ?? 'Resource' }} · {{ modal.props.images?.length ?? 0 }} images</p>
+ <template #title>{{ modalProps.title ?? 'Edit Images' }}</template>
+ <template #description>
+ <p>{{ modalProps.resource.title }}: {{ modalProps.images.length }}</p>
+ <EditItemHeader
+ v-if="modalProps.resource.edited_at && modalProps.resource.editor_id"
+ :edited_at="modalProps.resource.edited_at"
+ :editor_id="modalProps.resource.editor_id"
+ />
</template>
- <EditImages v-if="modal.props.resource && modal.props.images" :media="modal.props.resource" :images="modal.props.images" @handleFinish="handleVideoDetailsUpdate" />
+ <EditImages
+ v-if="modalProps.resource && modalProps.images"
+ :filters="['poster', 'preview']"
+ :readOnlyTypes="['preview']"
+ :primary-ids="{ poster: modalProps.resource.poster_image?.id }"
+ :images="modalProps.images"
+ :is-audio="modalProps.resource.media_type === MediaType.AUDIO"
+ :submit-fn="(formData) => updateMediaImage(modalProps.resource.id, formData)"
+ @handleFinish="handleVideoDetailsUpdate"
+ />
</BaseModal>
</template>
diff --git a/resources/js/stores/ModalStore.ts b/resources/js/stores/ModalStore.ts
index db6040df..65ec60b1 100644
--- a/resources/js/stores/ModalStore.ts
+++ b/resources/js/stores/ModalStore.ts
@@ -1,4 +1,6 @@
-import { shallowRef, ref, reactive, type Component } from 'vue';
+import type { Component } from 'vue';
+
+import { shallowRef, ref, reactive } from 'vue';
import { defineStore } from 'pinia';
export const useModalStore = defineStore('Modal', () => {
@@ -11,7 +13,7 @@ export const useModalStore = defineStore('Modal', () => {
const animationTime = ref(300);
const timeoutId = ref<number | null>(null);
- function open(comp: Component, newProps: Record<string, any> = {}) {
+ function open<T extends Record<string, any>>(comp: Component, newProps: T = {} as T) {
if (timeoutId.value) clearTimeout(timeoutId.value);
component.value = comp;
@@ -35,6 +37,10 @@ export const useModalStore = defineStore('Modal', () => {
}, animationTime.value);
}
+ function getProps<T extends Record<string, any>>(): T {
+ return props as T;
+ }
+
return {
props,
isOpen,
@@ -43,5 +49,6 @@ export const useModalStore = defineStore('Modal', () => {
animationTime,
open,
close,
+ getProps,
};
});
diff --git a/resources/js/types/imageRequests.ts b/resources/js/types/imageRequests.ts
index 2c021dc9..a3da13cc 100644
--- a/resources/js/types/imageRequests.ts
+++ b/resources/js/types/imageRequests.ts
@@ -1,36 +1,23 @@
+import type { ImageType } from '@/types/resources';
+
export type MediaImageType = 'poster';
export type SeriesImageType = 'poster' | 'banner';
export type UserImageType = 'avatar' | 'banner';
export type ImageUpdateType = 'existing' | 'upload' | 'url' | 'remove';
-type ImageUpdateRequest<T extends string> =
- | {
- mode: 'existing';
- type: T;
- image_id: number | null;
- }
- | {
- mode: 'upload';
- type: T;
- file: File;
- }
- | {
- mode: 'url';
- type: T;
- url: string;
- }
- | {
- mode: 'remove';
- type: T;
- };
+export type ImageUpdateRequest<T extends ImageType> =
+ | { mode: 'existing'; type: T; image_id: number | null }
+ | { mode: 'upload'; type: T; file: File }
+ | { mode: 'url'; type: T; url: string }
+ | { mode: 'remove'; type: T };
-export interface ImageFormState<T extends string> {
+export interface ImageFormState<T extends ImageType> {
type: T;
mode: ImageUpdateType;
image_id?: number | string | null;
- file?: File;
- url?: string;
+ file?: File | null;
+ url?: string | null;
}
export type MediaImageUpdateRequest = ImageUpdateRequest<MediaImageType>;
diff --git a/resources/js/types/modals.ts b/resources/js/types/modals.ts
new file mode 100644
index 00000000..397b1fdd
--- /dev/null
+++ b/resources/js/types/modals.ts
@@ -0,0 +1,15 @@
+import type { ImageResource, MetadataResource, SeriesResource } from './resources';
+
+export interface SeriesImageEditorProps {
+ resource: SeriesResource;
+ images: ImageResource[];
+ isMajorityAudio: boolean;
+ title?: string;
+ queryKeys?: string[][];
+}
+
+export interface MediaImageEditorProps {
+ resource: MetadataResource;
+ images: ImageResource[];
+ title?: string;
+}