Skip to content

A self-hosted media server and file management system

feat: generalise forms and allow folder tag editing

aminnausin18bfcffbef40
diff --git a/resources/js/components/forms/EditFolder.vue b/resources/js/components/forms/EditFolder.vue
index c5724a4e..58f8944a 100644
--- a/resources/js/components/forms/EditFolder.vue
+++ b/resources/js/components/forms/EditFolder.vue
@@ -1,6 +1,12 @@
-<script setup>
+<script setup lang="ts">
+import type { FolderResource, FolderTagResource, TagResource } from '@/types/resources';
+import type { FormField, SelectItem } from '@/types/types';
+import type { SeriesUpdateRequest } from '@/types/requests';
+
import { handleStorageURL, toCalendarFormattedDate } from '@/service/util';
-import { reactive } from 'vue';
+import { onMounted, reactive, ref, watch } from 'vue';
+import { useGetAllTags } from '@/service/queries';
+import { UseCreateTag } from '@/service/mutations';
import { toast } from '@/service/toaster/toastService';
import FormInputNumber from '@/components/inputs/FormInputNumber.vue';
@@ -10,12 +16,17 @@ import DatePicker from '@/components/pinesUI/DatePicker.vue';
import FormInput from '@/components/inputs/FormInput.vue';
import mediaAPI from '@/service/mediaAPI.ts';
import useForm from '@/composables/useForm';
+import InputMultiChip from '../pinesUI/InputMultiChip.vue';
const emit = defineEmits(['handleFinish']);
-const props = defineProps(['folder']);
+const props = defineProps<{ folder: FolderResource }>();
+
+const { data: tagsQuery } = useGetAllTags();
+const createTag = UseCreateTag();
+const allTags = ref<TagResource[]>([]);
// 'title', 'description', 'studio', 'seasons', 'episodes', 'films', 'date_start', 'date_end', 'thumbnail_url', 'editor_id';
-const fields = reactive([
+const fields = reactive<FormField[]>([
{
name: 'title',
text: 'Title',
@@ -72,7 +83,7 @@ const fields = reactive([
text: 'Start Date',
type: 'date',
value: props.folder?.series?.date_start ? toCalendarFormattedDate(props.folder?.series?.date_start) : null,
- subtext: 'The release date of the first video in the series',
+ subtext: 'The release date of the first item in the series',
default: null,
},
{
@@ -80,7 +91,7 @@ const fields = reactive([
text: 'End Date',
type: 'date',
value: props.folder?.series?.date_end ? toCalendarFormattedDate(props.folder?.series?.date_end) : null,
- subtext: 'The release date of the last video in the series',
+ subtext: 'The release date of the last item in the series',
default: null,
},
{
@@ -91,29 +102,40 @@ const fields = reactive([
subtext: 'A thumbnail associated with the series',
default: null,
},
+ {
+ name: 'tags',
+ text: 'Tags',
+ type: 'multi',
+ value: props.folder?.series?.folder_tags ?? [],
+ default: props.folder?.series?.folder_tags ?? [],
+ subtext: 'Tags that describe the folder',
+ max: 24,
+ },
]);
-const form = useForm({
+const form = useForm<SeriesUpdateRequest>({
folder_id: props.folder.id,
title: props.folder?.series?.title ?? props.folder?.name,
description: props.folder?.series?.description ?? '',
studio: props.folder?.series?.studio ?? '',
- episodes: props.folder?.series?.episodes ?? null,
- seasons: props.folder?.series?.seasons ?? null,
- films: props.folder?.series?.films ?? null,
+ episodes: props.folder?.series?.episodes?.toString() ?? null,
+ seasons: props.folder?.series?.seasons?.toString() ?? null,
+ films: props.folder?.series?.films?.toString() ?? null,
date_start: props.folder?.series?.date_start ? toCalendarFormattedDate(props.folder?.series?.date_start) : null,
date_end: props.folder?.series?.date_end ? toCalendarFormattedDate(props.folder?.series?.date_end) : null,
thumbnail_url: handleStorageURL(props.folder?.series?.thumbnail_url) ?? null,
+ tags: props.folder.series?.folder_tags ?? [],
+ deleted_tags: [],
});
const handleSubmit = async () => {
form.submit(
async (fields) => {
if (!props.folder?.series?.id) {
- return mediaAPI.createSeries(fields);
+ return mediaAPI.createSeries({ ...fields, folder_id: -1 });
}
- return mediaAPI.updateSeries(props.folder?.series?.id, fields);
+ return mediaAPI.updateSeries(props.folder?.series?.id, { ...fields });
},
{
onSuccess: (response) => {
@@ -126,6 +148,49 @@ const handleSubmit = async () => {
},
);
};
+
+const handleCreateTag = async (name: string) => {
+ try {
+ const { data: response } = await createTag.mutateAsync({ name });
+
+ toast.add('Success', { type: 'success', description: 'Tag created!', life: 3000 });
+ form.fields['tags'] = [...form.fields['tags'], { id: response.id, name: response.name }];
+ } catch (error) {
+ console.log(error);
+ toast.error('Unable to create tag. It may already exist.');
+ }
+};
+
+const handleSetTags = (newTags: FolderTagResource[]) => {
+ const existingTags = props.folder?.series?.folder_tags ?? [];
+
+ form.fields['tags'] = newTags.map((tag) => ({
+ id: tag.id,
+ name: tag.name,
+ folder_tag_id: existingTags.find((existingTag) => existingTag.id === tag.id)?.folder_tag_id,
+ }));
+
+ // Take tags from existing list
+ form.fields['deleted_tags'] = existingTags.filter((existingTag) => !newTags.some((tag) => tag.id === existingTag.id)).map((tag) => tag.folder_tag_id);
+};
+
+const handleRemoveTag = (tag: FolderTagResource) => {
+ console.log(tag);
+
+ form.fields['tags'] = form.fields['tags']?.filter((itm) => itm.name !== tag.name);
+
+ if (tag.folder_tag_id) form.fields['deleted_tags'] = [...form.fields['deleted_tags'], tag.folder_tag_id];
+};
+
+onMounted(() => {
+ console.log(props.folder);
+});
+
+watch(tagsQuery, () => {
+ if (tagsQuery.value?.data?.data) {
+ allTags.value = tagsQuery.value.data.data; // Array of tag resources
+ }
+});
</script>
<template>
@@ -136,7 +201,18 @@ const handleSubmit = async () => {
<FormTextArea v-if="field.type === 'textArea'" v-model="form.fields[field.name]" :field="field" />
<DatePicker v-else-if="field.type === 'date'" v-model="form.fields[field.name]" :field="field" />
<FormInputNumber v-else-if="field.type === 'number'" v-model="form.fields[field.name]" :field="field" />
+ <InputMultiChip
+ v-else-if="field.name === 'tags'"
+ :placeholder="'Add tags'"
+ :defaultItems="(form.fields[field.name] as SelectItem[]) ?? []"
+ :options="allTags"
+ :max="field.max"
+ @createAction="handleCreateTag"
+ @selectItems="handleSetTags"
+ @removeAction="handleRemoveTag"
+ />
<FormInput v-else v-model="form.fields[field.name]" :field="field" />
+
<ul class="text-sm text-rose-600 dark:text-rose-400">
<li v-for="(item, index) in form.errors[field.name]" :key="index">{{ item }}</li>
</ul>
diff --git a/resources/js/components/forms/EditVideo.vue b/resources/js/components/forms/EditVideo.vue
index 05f84960..66861d11 100755
--- a/resources/js/components/forms/EditVideo.vue
+++ b/resources/js/components/forms/EditVideo.vue
@@ -1,7 +1,11 @@
-<script setup>
+<script setup lang="ts">
+import type { TagResource, VideoResource, VideoTagResource } from '@/types/resources';
+import { type FormField, type SelectItem } from '@/types/types';
+import type { MetadataUpdateRequest } from '@/types/requests';
+
import { toCalendarFormattedDate } from '@/service/util';
import { reactive, ref, watch } from 'vue';
-import { useGetVideoTags } from '@/service/queries';
+import { useGetAllTags } from '@/service/queries';
import { UseCreateTag } from '@/service/mutations';
import { toast } from '@/service/toaster/toastService';
@@ -15,13 +19,13 @@ import mediaAPI from '@/service/mediaAPI.ts';
import useForm from '@/composables/useForm';
const emit = defineEmits(['handleFinish']);
-const props = defineProps(['video']);
+const props = defineProps<{ video: VideoResource }>();
-const { data: tagsQuery } = useGetVideoTags();
+const { data: tagsQuery } = useGetAllTags();
const createTag = UseCreateTag();
-const allTags = ref([]);
-const fields = reactive([
+const allTags = ref<TagResource[]>([]);
+const fields = reactive<FormField[]>([
{
name: 'title',
text: 'Title',
@@ -29,7 +33,7 @@ const fields = reactive([
required: true,
value: props.video?.title,
default: props.video?.name,
- subtext: 'The intended title of the video',
+ subtext: 'The intended title of the media',
max: 255,
},
{
@@ -60,7 +64,7 @@ const fields = reactive([
text: 'Video Thumbnail URL',
type: 'url',
value: props.video?.metadata?.poster_url,
- subtext: 'A thumbnail associated with the video',
+ subtext: 'A thumbnail associated with the media',
default: null,
},
{
@@ -76,17 +80,17 @@ const fields = reactive([
type: 'multi',
value: props.video?.video_tags ?? [],
default: props.video?.video_tags ?? [],
- subtext: 'Tags that describe the video',
+ subtext: 'Tags that describe the media',
max: 24,
},
]);
-const form = useForm({
+const form = useForm<MetadataUpdateRequest>({
title: props.video?.title ?? props.video?.name,
description: props.video?.description ?? '',
episode: props.video?.episode?.toString() ?? '',
season: props.video?.season?.toString() ?? '',
- poster_url: props.video?.metadata.poster_url ?? '',
+ poster_url: props.video?.metadata?.poster_url ?? '',
date_released: props.video?.date_released ? toCalendarFormattedDate(props.video?.date_released) : '',
video_tags: props.video?.video_tags ?? [],
deleted_tags: [],
@@ -105,13 +109,13 @@ const handleSubmit = async () => {
toast.add('Success', { type: 'success', description: 'Edit submitted!', life: 3000 });
},
onError: () => {
- toast.add('Error', { type: 'danger', description: 'Unable to update video details.', life: 3000 });
+ toast.add('Error', { type: 'danger', description: 'Unable to update media details.', life: 3000 });
},
},
);
};
-const handleCreateTag = async (name) => {
+const handleCreateTag = async (name: string) => {
try {
const { data: response } = await createTag.mutateAsync({ name });
@@ -119,18 +123,27 @@ const handleCreateTag = async (name) => {
form.fields['video_tags'] = [...form.fields['video_tags'], { id: response.id, name: response.name }];
} catch (error) {
console.log(error);
-
- toast.add('Error', { type: 'error', description: 'Unable to create tag. It may already exist.', life: 3000 });
+ toast.error('Unable to create tag. It may already exist.');
}
};
-const handleSetTags = (tags) => {
- form.fields['video_tags'] = [...tags];
- form.fields['deleted_tags'] = form.fields['deleted_tags'].filter((itm) => !tags.find((newTag) => newTag.name === itm.name));
+const handleSetTags = (newTags: VideoTagResource[]) => {
+ const existingVideoTags = props.video.video_tags ?? [];
+
+ form.fields['video_tags'] = newTags.map((tag) => ({
+ id: tag.id,
+ name: tag.name,
+ video_tag_id: existingVideoTags.find((vt) => vt.id === tag.id)?.video_tag_id,
+ }));
+
+ // Take tags from existing list
+ form.fields['deleted_tags'] = existingVideoTags.filter((videoTag) => !newTags.some((tag) => tag.id === videoTag.id)).map((videoTag) => videoTag.video_tag_id);
};
-const handleRemoveTag = (tag) => {
- form.fields['video_tags'] = form.fields['video_tags'].filter((itm) => itm.name !== tag.name);
+const handleRemoveTag = (tag: VideoTagResource) => {
+ console.log(tag);
+
+ form.fields['video_tags'] = form.fields['video_tags']?.filter((itm) => itm.name !== tag.name);
if (tag.video_tag_id) form.fields['deleted_tags'] = [...form.fields['deleted_tags'], tag.video_tag_id];
};
@@ -153,7 +166,7 @@ watch(tagsQuery, () => {
<InputMultiChip
v-else-if="field.name === 'video_tags'"
:placeholder="'Add tags'"
- :defaultItems="form.fields[field.name] ? form.fields[field.name] : []"
+ :defaultItems="(form.fields[field.name] as SelectItem[]) ?? []"
:options="allTags"
:max="field.max"
@createAction="handleCreateTag"
diff --git a/resources/js/composables/useForm.ts b/resources/js/composables/useForm.ts
index 8ba2bd91..4e6e8e39 100644
--- a/resources/js/composables/useForm.ts
+++ b/resources/js/composables/useForm.ts
@@ -3,6 +3,9 @@ import { reactive, watch } from 'vue';
import cloneDeep from 'lodash.clonedeep';
import isEqual from 'lodash.isequal';
+export type FormFieldValue = string | number | boolean | Array<any> | null;
+type FormFields<T> = T & { [key: string]: FormFieldValue };
+
interface FormHooks {
onBefore?: () => any;
onSuccess?: (response: any) => any;
@@ -10,24 +13,25 @@ interface FormHooks {
onFinish?: () => any;
}
-interface FormState {
- fields: { [key: string]: string | boolean };
+interface FormState<T> {
+ fields: FormFields<T>;
errors: { [key: string]: string };
dirty: boolean;
hasErrors: boolean;
processing: boolean;
wasSuccessful: boolean;
recentlySuccessful: boolean;
- submit: (submitFn: (fields: { [key: string]: string | boolean }) => Promise<any>, hooks?: FormHooks) => Promise<void>;
- reset: (...fields: string[]) => void;
+ submit: (submitFn: (fields: FormFields<T>) => Promise<any>, hooks?: FormHooks) => Promise<void>;
+ reset: (...fields: (keyof FormFields<T>)[]) => void;
clearErrors: (...fields: string[]) => void;
setErrors: (errors: { [key: string]: string }) => void;
}
-export default function useForm(fields: { [key: string]: string | boolean }) {
+export default function useForm<T extends Record<string, any>>(fields: FormFields<T>) {
let defaults = fields;
let recentlySuccessfulTimeoutId: number;
- const form = reactive<FormState>({
+
+ const form = reactive<FormState<T>>({
fields: cloneDeep(fields),
errors: {},
dirty: false,
@@ -36,7 +40,7 @@ export default function useForm(fields: { [key: string]: string | boolean }) {
wasSuccessful: false,
recentlySuccessful: false,
- async submit(submitFn: (fields: { [key: string]: string | boolean }) => any, hooks = {}) {
+ async submit(submitFn: (fields: T) => any, hooks = {}) {
if (this.processing) return;
const _hooks = {
@@ -100,7 +104,7 @@ export default function useForm(fields: { [key: string]: string | boolean }) {
} else {
fields.forEach((field) => {
if (clonedDefaults[field] !== undefined) {
- this.fields[field] = clonedDefaults[field];
+ (this.fields[field] as (typeof clonedDefaults)[typeof field]) = clonedDefaults[field];
}
});
}
diff --git a/resources/js/service/mediaAPI.ts b/resources/js/service/mediaAPI.ts
index 4a739f38..b899a1fc 100644
--- a/resources/js/service/mediaAPI.ts
+++ b/resources/js/service/mediaAPI.ts
@@ -4,8 +4,10 @@
Have create, get, update actions
Run and commit to database (store) -> ?? What does that mean?
*/
-import type { MetadataResource, SeriesResource, VideoResource } from '@/types/resources';
-import { API } from './api';
+import type { MetadataStoreRequest, MetadataUpdateRequest, SeriesStoreRequest, SeriesUpdateRequest } from '@/types/requests';
+import type { VideoResource } from '@/types/resources';
+
+import { API } from '@/service/api';
export default {
viewVideo(id: number) {
@@ -14,16 +16,16 @@ export default {
updateVideo(id: number, data: VideoResource) {
return API.patch(`/videos/${id}`, data);
},
- createMetadata(data: MetadataResource) {
+ createMetadata(data: MetadataStoreRequest) {
return API.post(`/metadata/`, data);
},
- updateMetadata(id: number, data: MetadataResource) {
+ updateMetadata(id: number, data: MetadataUpdateRequest) {
return API.patch(`/metadata/${id}`, data);
},
- createSeries(data: SeriesResource) {
+ createSeries(data: SeriesStoreRequest) {
return API.post(`/series`, data);
},
- updateSeries(id: number, data: SeriesResource) {
+ updateSeries(id: number, data: SeriesUpdateRequest) {
return API.patch(`/series/${id}`, data);
},
getCategory(query: string) {
diff --git a/resources/js/service/mutations.ts b/resources/js/service/mutations.ts
index eb544cfe..579fb8e7 100644
--- a/resources/js/service/mutations.ts
+++ b/resources/js/service/mutations.ts
@@ -28,7 +28,7 @@ export const UseCreateTag = () => {
onSettled: async () => {
// console.log(variable);
await queryClient.invalidateQueries({
- queryKey: ['videoTags'],
+ queryKey: ['allTags'],
});
},
});
diff --git a/resources/js/service/queries.ts b/resources/js/service/queries.ts
index 149ab14c..a40d5fff 100644
--- a/resources/js/service/queries.ts
+++ b/resources/js/service/queries.ts
@@ -9,9 +9,9 @@ import { useQuery } from '@tanstack/vue-query';
import mediaAPI, { getCategories, getFolders } from '@/service/mediaAPI.ts';
-export const useGetVideoTags = () => {
+export const useGetAllTags = () => {
return useQuery({
- queryKey: ['videoTags'],
+ queryKey: ['allTags'],
queryFn: async () => {
return mediaAPI.getTags();
},
diff --git a/resources/js/types/model.ts b/resources/js/types/model.ts
index 250b04cb..59a26962 100644
--- a/resources/js/types/model.ts
+++ b/resources/js/types/model.ts
@@ -86,16 +86,9 @@ export interface Series {
updated_at?: string;
folder?: Folder;
editor?: User;
+ folder_tags?: FolderTag[];
}
-export interface Tag {
- id: number;
- creator_id?: number;
- name: string;
- created_at?: string;
- updated_at?: string;
- creator?: User;
- metadata?: Metadata;
-}
+
export interface User {
id: number;
name: string;
@@ -120,12 +113,24 @@ export interface Video {
folder?: Folder;
metadata?: Metadata;
}
+export interface Tag {
+ id: number;
+ creator_id?: number;
+ name: string;
+ created_at?: string;
+ updated_at?: string;
+}
export interface VideoTag {
id: number;
tag_id: number;
metadata_id: number;
created_at?: string;
updated_at?: string;
- metadata?: Metadata;
- tag?: Tag;
+}
+export interface FolderTag {
+ id: number;
+ tag_id: number;
+ series_id: number;
+ created_at?: string;
+ updated_at?: string;
}
diff --git a/resources/js/types/requests.ts b/resources/js/types/requests.ts
new file mode 100644
index 00000000..66c4b091
--- /dev/null
+++ b/resources/js/types/requests.ts
@@ -0,0 +1,33 @@
+export interface MetadataStoreRequest extends MetadataUpdateRequest {
+ video_id: number;
+}
+
+export interface MetadataUpdateRequest {
+ title: string;
+ description?: string;
+ episode?: string;
+ season?: string;
+ poster_url?: string;
+ date_released?: string;
+ video_tags: { name: string; id: number; video_tag_id?: number }[];
+ deleted_tags: number[];
+}
+
+export interface SeriesStoreRequest extends SeriesUpdateRequest {
+ folder_id: number;
+}
+
+export interface SeriesUpdateRequest {
+ title: string;
+ description?: string | null;
+ studio?: string | null;
+ rating?: string | null;
+ seasons?: string | null;
+ episodes?: string | null;
+ films?: string | null;
+ date_start?: string | null;
+ date_end?: string | null;
+ thumbnail_url?: string | null;
+ tags: { name: string; id: number; folder_tag_id?: number }[];
+ deleted_tags: number[];
+}
diff --git a/resources/js/types/resources.ts b/resources/js/types/resources.ts
index edfc62bb..a0e96be8 100644
--- a/resources/js/types/resources.ts
+++ b/resources/js/types/resources.ts
@@ -95,6 +95,7 @@ export interface SeriesResource {
seasons?: number;
episodes?: number;
films?: number;
+ folder_tags?: FolderTagResource[];
date_start?: string;
date_end?: string;
thumbnail_url?: string;
@@ -104,7 +105,7 @@ export interface TagResource {
id: number;
name: string;
relationships: {
- creator_id?: number;
+ creator_id: number | null;
};
}
// export interface UserResource {
@@ -137,7 +138,13 @@ export interface VideoResource {
}
export interface VideoTagResource {
video_tag_id: number; // video tag (this) id
- name?: string;
+ name: string;
+ id: number; // tag id
+}
+
+export interface FolderTagResource {
+ folder_tag_id: number; // folder tag (this) id
+ name: string;
id: number; // tag id
}
diff --git a/resources/js/types/types.ts b/resources/js/types/types.ts
index c2236928..bca25956 100644
--- a/resources/js/types/types.ts
+++ b/resources/js/types/types.ts
@@ -144,16 +144,6 @@ export interface TaskStatsResponse {
count_subtasks: number;
}
-export interface FormField {
- name: string;
- text: string;
- type?: 'text' | 'url' | 'textArea' | 'date' | 'number' | 'multi' | 'select';
- value?: any;
- subtext?: string;
- default?: any;
- class?: string;
-}
-
export type TaskStatus = 'pending' | 'processing' | 'completed' | 'cancelled' | 'failed' | 'incomplete';
export interface ContextMenuItem {
@@ -244,3 +234,24 @@ export declare type Broadcaster = {
};
export declare type SortDir = 1 | -1;
+
+export declare type FieldType = 'text' | 'textArea' | 'number' | 'date' | 'url' | 'multi' | 'select';
+
+export interface FormField {
+ name: string;
+ text?: string;
+ subtext?: string;
+ type: FieldType;
+ required?: boolean;
+ value?: any;
+ default?: any;
+ min?: number;
+ max?: number;
+ class?: string;
+}
+
+export interface SelectItem {
+ id: number;
+ name: string;
+ relationships?: any;
+}