ytptube/ui/app/components/DLFields.vue
2026-02-20 22:46:30 +03:00

339 lines
12 KiB
Vue

<template>
<form class="modal is-active" @submit.prevent="updateItems">
<div class="modal-background" @click="cancel" />
<div class="modal-card" style="min-width: calc(100vw - 30vw)">
<header class="modal-card-head">
<p class="modal-card-title">Manage Custom Fields</p>
<button type="button" class="delete" aria-label="close" @click="cancel" />
</header>
<section class="modal-card-body">
<div class="columns is-multiline">
<div class="column is-12 is-clearfix is-unselectable">
<span class="title is-4">
<span class="icon-text">
<span class="icon"><i class="fas fa-plus" /></span>
<span>Custom Fields</span>
</span>
</span>
<div class="is-pulled-right">
<div class="field is-grouped">
<p class="control">
<button
type="button"
class="button is-primary"
@click="addNewField"
:disabled="isLoading"
>
<span class="icon"><i class="fas fa-add" /></span>
</button>
</p>
<p class="control">
<button
type="button"
class="button is-info"
@click="loadContent()"
:class="{ 'is-loading': isLoading }"
:disabled="isLoading"
>
<span class="icon"><i class="fas fa-refresh" /></span>
</button>
</p>
</div>
</div>
<div class="is-hidden-mobile">
<span class="subtitle"
>The idea behind the custom fields is to allow you to add new fields to the download
form to automate some of the yt-dlp options.</span
>
</div>
</div>
<div class="column is-12" v-for="(item, index) in sortedDLFields" :key="item.id || index">
<div class="box">
<div class="columns is-multiline">
<div class="column is-12 is-12-mobile">
<NuxtLink
@click="deleteField(index)"
:disabled="isLoading"
class="has-text-danger"
>
<span class="icon"><i class="fas fa-trash" /></span>
<span>Delete Field</span>
</NuxtLink>
</div>
<div class="column is-6 is-12-mobile">
<div class="field">
<label class="label">
<span class="icon"><i class="fas fa-cog" /></span>
<span>Field Type</span>
</label>
<div class="select is-fullwidth" :class="{ 'is-loading': isLoading }">
<select v-model="item.kind" :disabled="isLoading" class="is-capitalized">
<option
v-for="kind in Object.values(FieldTypes)"
:key="`kind-${kind}`"
:value="kind"
v-text="kind"
/>
</select>
</div>
<span class="help is-bold">
Field Type. String is a single line input, Text is a multi-line input, Bool is
a checkbox.
</span>
</div>
</div>
<div class="column is-6 is-12-mobile">
<div class="field">
<label class="label">
<span class="icon"><i class="fas fa-font" /></span>
<span>Field Name</span>
</label>
<input type="text" v-model="item.name" class="input" :disabled="isLoading" />
<span class="help is-bold">
The name of the field, it will be shown in the UI.
</span>
</div>
</div>
<div class="column is-6 is-12-mobile">
<div class="field">
<label class="label">
<span class="icon"><i class="fas fa-terminal" /></span>
<span>Associated yt-dlp option</span>
</label>
<InputAutocomplete
v-model="item.field"
:options="ytDlpOptions"
:disabled="isLoading"
placeholder="Type or select a yt-dlp option"
:multiple="false"
:openOnFocus="true"
/>
<span class="help is-bold">
The long form of yt-dlp option name, e.g. <code>--no-overwrites</code> not
<code>-w</code>.
</span>
</div>
</div>
<div class="column is-6 is-12-mobile">
<div class="field">
<label class="label">
<span class="icon"><i class="fas fa-info-circle" /></span>
<span>Field Description</span>
</label>
<input
type="text"
v-model="item.description"
class="input"
:disabled="isLoading"
/>
<span class="help is-bold">
A short description of the field, it will be shown in the UI.
</span>
</div>
</div>
<div class="column is-6 is-12-mobile">
<div class="field">
<label class="label">
<span class="icon"><i class="fas fa-sort-numeric-up" /></span>
<span>Field Order</span>
</label>
<input type="number" v-model="item.order" class="input" :disabled="isLoading" />
<span class="help is-bold">
The order of the field, used to sort the fields in the UI. Lower numbers will
appear first.
</span>
</div>
</div>
<div class="column is-6 is-12-mobile">
<div class="field">
<label class="label">
<span class="icon"><i class="fas fa-image" /></span>
<span>Field Icon</span>
</label>
<input type="text" v-model="item.icon" class="input" :disabled="isLoading" />
<span class="help is-bold">
The icon of the field, must be from
<NuxtLink href="https://fontawesome.com/search?ic=free&o=r" target="_blank">
font-awesome</NuxtLink
>
icon. e.g. <code>fa-solid fa-image</code>. Leave empty for no icon.
</span>
</div>
</div>
</div>
</div>
</div>
<div class="column is-12">
<Message class="is-warning" v-if="items.length === 0">
<span class="icon"><i class="fas fa-exclamation-circle" /></span>
<span>No custom fields found, you can add new fields using the button above.</span>
</Message>
</div>
</div>
</section>
<footer class="modal-card-foot p-5">
<div class="field is-grouped" style="width: 100%">
<div class="control is-expanded">
<button type="submit" class="button is-fullwidth is-primary" :disabled="isLoading">
<span class="icon"><i class="fas fa-save" /></span>
<span>Save</span>
</button>
</div>
<div class="control is-expanded">
<button
type="button"
class="button is-fullwidth is-danger"
@click="cancel"
:disabled="isLoading"
>
<span class="icon"><i class="fas fa-times" /></span>
<span>Cancel</span>
</button>
</div>
</div>
</footer>
</div>
</form>
</template>
<script setup lang="ts">
import { ref } from 'vue';
import InputAutocomplete from '~/components/InputAutocomplete.vue';
import { disableOpacity, enableOpacity } from '~/utils';
import type { DLField } from '~/types/dl_fields';
import type { AutoCompleteOptions } from '~/types/autocomplete';
const emitter = defineEmits<{ (e: 'cancel'): void }>();
const toast = useNotification();
const isLoading = ref<boolean>(false);
const items = ref<DLField[]>([]);
const config = useConfigStore();
const ytDlpOptions = ref<AutoCompleteOptions>([]);
const FieldTypes = {
STRING: 'string',
TEXT: 'text',
BOOL: 'bool',
};
const cancel = () => emitter('cancel');
const loadContent = async () => {
try {
isLoading.value = true;
const response = await request('/api/dl_fields');
const data = await response.json();
if (0 === data.length) {
return;
}
items.value = data;
} catch (e: any) {
console.error(e);
toast.error('Failed to fetch page content.');
} finally {
isLoading.value = false;
}
};
const updateItems = async () => {
for (const item of items.value) {
if (validateItem(item, items.value.indexOf(item) + 1)) {
continue;
}
return;
}
try {
isLoading.value = true;
const resp = await request('/api/dl_fields', {
method: 'PUT',
body: JSON.stringify(items.value),
});
if (!resp.ok) {
const error = await resp.json();
toast.error(`Failed to update fields: ${error.error || 'Unknown error'}`);
return;
}
toast.success('Fields updated successfully.');
emitter('cancel');
} finally {
isLoading.value = false;
}
};
const addNewField = () =>
items.value.push({
name: '',
description: '',
kind: 'string',
field: '',
value: '',
icon: '',
order: items.value.reduce((max, item) => Math.max(max, item.order || 1), 0) + 1,
extras: {},
});
const deleteField = (index: number) => items.value.splice(index, 1);
const validateItem = (item: DLField, index: number): boolean => {
const requiredFields = ['name', 'field', 'kind', 'description'];
for (const field of requiredFields) {
if (!item[field as keyof DLField]) {
toast.error(`${item.name || index}: Field ${field} is required.`);
return false;
}
}
if (!item.order || item.order < 1) {
toast.error(`${item.name || index}: Order must be a positive number.`);
return false;
}
if (!Object.values(FieldTypes).includes(item.kind)) {
toast.error(`${item.name || index}: Invalid field type: ${item.kind}`);
return false;
}
if (!/^--[a-zA-Z0-9-]+$/.test(item.field)) {
toast.error(
`${item.name || index}: Invalid field format, it must start with '--' and contain no spaces.`,
);
return false;
}
return true;
};
// eslint-disable-next-line vue/no-side-effects-in-computed-properties
const sortedDLFields = computed(() => items.value.sort((a, b) => (a.order || 0) - (b.order || 0)));
watch(
() => config.ytdlp_options,
(newOptions) =>
(ytDlpOptions.value = newOptions
.filter((opt) => !opt.ignored)
.flatMap((opt) =>
opt.flags
.filter((flag) => flag.startsWith('--'))
.map((flag) => ({ value: flag, description: opt.description || '' })),
)),
{ immediate: true },
);
onMounted(async () => {
disableOpacity();
await loadContent();
});
onBeforeUnmount(() => enableOpacity());
</script>