xpltdco/tubearr
2
0
Fork 0
Code Issues 16 Pull requests Projects Releases Packages Wiki Activity Actions

feat: Add Generic platform, per-platform NFO toggle, and default view s…

Browse source 
- "src/db/schema/platform-settings.ts"
- "drizzle/0018_platform_settings_nfo_view.sql"
- "src/types/index.ts"
- "src/db/repositories/platform-settings-repository.ts"
- "src/server/routes/platform-settings.ts"
- "src/frontend/src/components/PlatformSettingsForm.tsx"
- "src/frontend/src/pages/Settings.tsx"
- "src/__tests__/platform-settings-api.test.ts"

GSD-Task: S04/T01
This commit is contained in:
jlightner 2026-04-04 09:56:53 +00:00
parent 4cabcfbb4c
commit 0f42a4b269
11 changed files with 1402 additions and 99 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
drizzle/0018_platform_settings_nfo_view.sql Normal file
View file

@ -0,0 +1,2 @@
ALTER TABLE `platform_settings` ADD `nfo_enabled` integer NOT NULL DEFAULT false;--> statement-breakpoint
ALTER TABLE `platform_settings` ADD `default_view` text NOT NULL DEFAULT 'list';

1147
drizzle/meta/0018_snapshot.json Normal file
View file

File diff suppressed because it is too large Load diff

7
drizzle/meta/_journal.json
View file

@ -127,6 +127,13 @@
"when": 1775282773898,
"tag": "0017_wild_havok",
"breakpoints": true
},
{
"idx": 18,
"version": "6",
"when": 1775520100000,
"tag": "0018_platform_settings_nfo_view",
"breakpoints": true
}
]
}

131
src/__tests__/platform-settings-api.test.ts
View file

@ -344,6 +344,137 @@ describe('Platform Settings API', () => {
});
});
// ── Generic platform ──
describe('Generic platform', () => {
it('accepts generic as a valid platform', async () => {
const res = await server.inject({
method: 'PUT',
url: '/api/v1/platform-settings/generic',
headers: { 'x-api-key': apiKey },
payload: {
checkInterval: 480,
concurrencyLimit: 1,
},
});
expect(res.statusCode).toBe(200);
const body = res.json();
expect(body.platform).toBe('generic');
expect(body.checkInterval).toBe(480);
expect(body.nfoEnabled).toBe(false);
expect(body.defaultView).toBe('list');
});
it('shows generic in list of all platform settings', async () => {
const res = await server.inject({
method: 'GET',
url: '/api/v1/platform-settings',
headers: { 'x-api-key': apiKey },
});
expect(res.statusCode).toBe(200);
const platforms = res.json().map((s: { platform: string }) => s.platform);
expect(platforms).toContain('generic');
});
});
// ── nfoEnabled ──
describe('nfoEnabled', () => {
it('persists nfoEnabled through PUT → GET round-trip', async () => {
const putRes = await server.inject({
method: 'PUT',
url: '/api/v1/platform-settings/youtube',
headers: { 'x-api-key': apiKey },
payload: {
nfoEnabled: true,
},
});
expect(putRes.statusCode).toBe(200);
expect(putRes.json().nfoEnabled).toBe(true);
const getRes = await server.inject({
method: 'GET',
url: '/api/v1/platform-settings/youtube',
headers: { 'x-api-key': apiKey },
});
expect(getRes.statusCode).toBe(200);
expect(getRes.json().nfoEnabled).toBe(true);
});
it('defaults nfoEnabled to false when not specified', async () => {
await server.inject({
method: 'DELETE',
url: '/api/v1/platform-settings/generic',
headers: { 'x-api-key': apiKey },
});
const putRes = await server.inject({
method: 'PUT',
url: '/api/v1/platform-settings/generic',
headers: { 'x-api-key': apiKey },
payload: { checkInterval: 360 },
});
expect(putRes.statusCode).toBe(200);
expect(putRes.json().nfoEnabled).toBe(false);
});
});
// ── defaultView ──
describe('defaultView', () => {
it('persists defaultView through PUT → GET round-trip', async () => {
const putRes = await server.inject({
method: 'PUT',
url: '/api/v1/platform-settings/youtube',
headers: { 'x-api-key': apiKey },
payload: {
defaultView: 'poster',
},
});
expect(putRes.statusCode).toBe(200);
expect(putRes.json().defaultView).toBe('poster');
const getRes = await server.inject({
method: 'GET',
url: '/api/v1/platform-settings/youtube',
headers: { 'x-api-key': apiKey },
});
expect(getRes.statusCode).toBe(200);
expect(getRes.json().defaultView).toBe('poster');
});
it('rejects invalid defaultView value', async () => {
const res = await server.inject({
method: 'PUT',
url: '/api/v1/platform-settings/youtube',
headers: { 'x-api-key': apiKey },
payload: {
defaultView: 'grid',
},
});
expect(res.statusCode).toBe(400);
});
it('defaults defaultView to list when not specified', async () => {
await server.inject({
method: 'DELETE',
url: '/api/v1/platform-settings/generic',
headers: { 'x-api-key': apiKey },
});
const putRes = await server.inject({
method: 'PUT',
url: '/api/v1/platform-settings/generic',
headers: { 'x-api-key': apiKey },
payload: { checkInterval: 360 },
});
expect(putRes.statusCode).toBe(200);
expect(putRes.json().defaultView).toBe('list');
});
});
// ── Auth ──
describe('Authentication', () => {

8
src/db/repositories/platform-settings-repository.ts
View file

@ -18,6 +18,8 @@ export interface UpsertPlatformSettingsData {
scanLimit?: number;
rateLimitDelay?: number;
defaultMonitoringMode?: MonitoringMode;
nfoEnabled?: boolean;
defaultView?: 'list' | 'poster' | 'table';
}
type Db = LibSQLDatabase<typeof schema>;
@ -67,6 +69,8 @@ export async function upsertPlatformSettings(
scanLimit: data.scanLimit ?? 500,
rateLimitDelay: data.rateLimitDelay ?? 1000,
defaultMonitoringMode: data.defaultMonitoringMode ?? 'all',
nfoEnabled: data.nfoEnabled ?? false,
defaultView: data.defaultView ?? 'list',
createdAt: now,
updatedAt: now,
})
@ -82,6 +86,8 @@ export async function upsertPlatformSettings(
scanLimit: data.scanLimit ?? 500,
rateLimitDelay: data.rateLimitDelay ?? 1000,
defaultMonitoringMode: data.defaultMonitoringMode ?? 'all',
nfoEnabled: data.nfoEnabled ?? false,
defaultView: data.defaultView ?? 'list',
updatedAt: now,
},
})
@ -117,6 +123,8 @@ function mapRow(row: typeof platformSettings.$inferSelect): PlatformSettings {
scanLimit: row.scanLimit ?? 500,
rateLimitDelay: row.rateLimitDelay ?? 1000,
defaultMonitoringMode: (row.defaultMonitoringMode ?? 'all') as MonitoringMode,
nfoEnabled: row.nfoEnabled,
defaultView: (row.defaultView ?? 'list') as 'list' | 'poster' | 'table',
createdAt: row.createdAt,
updatedAt: row.updatedAt,
};

2
src/db/schema/platform-settings.ts
View file

@ -17,6 +17,8 @@ export const platformSettings = sqliteTable('platform_settings', {
scanLimit: integer('scan_limit').default(100),
rateLimitDelay: integer('rate_limit_delay').default(1000),
defaultMonitoringMode: text('default_monitoring_mode').notNull().default('all'),
nfoEnabled: integer('nfo_enabled', { mode: 'boolean' }).notNull().default(false),
defaultView: text('default_view').notNull().default('list'),
createdAt: text('created_at')
.notNull()
.default(sql`(datetime('now'))`),

2
src/frontend/src/api/hooks/usePlatformSettings.ts
View file

@ -41,6 +41,8 @@ export interface UpdatePlatformSettingsInput {
scanLimit?: number;
rateLimitDelay?: number;
defaultMonitoringMode?: 'all' | 'future' | 'existing' | 'none';
nfoEnabled?: boolean;
defaultView?: 'list' | 'poster' | 'table';
}
// ── Mutations ──

45
src/frontend/src/components/PlatformSettingsForm.tsx
View file

@ -14,6 +14,8 @@ export interface PlatformSettingsFormValues {
scanLimit: number;
rateLimitDelay: number;
defaultMonitoringMode: string;
nfoEnabled: boolean;
defaultView: 'list' | 'poster' | 'table';
}
interface PlatformSettingsFormProps {
@ -89,6 +91,8 @@ export function PlatformSettingsForm({
const [scanLimit, setScanLimit] = useState(settings?.scanLimit ?? 100);
const [rateLimitDelay, setRateLimitDelay] = useState(settings?.rateLimitDelay ?? 1000);
const [defaultMonitoringMode, setDefaultMonitoringMode] = useState(settings?.defaultMonitoringMode ?? 'all');
const [nfoEnabled, setNfoEnabled] = useState(settings?.nfoEnabled ?? false);
const [defaultView, setDefaultView] = useState<'list' | 'poster' | 'table'>(settings?.defaultView ?? 'list');
const handleSubmit = useCallback(
(e: FormEvent) => {
@ -103,12 +107,14 @@ export function PlatformSettingsForm({
scanLimit,
rateLimitDelay,
defaultMonitoringMode,
nfoEnabled,
defaultView,
});
},
[defaultFormatProfileId, checkInterval, concurrencyLimit, subtitleLanguages, grabAllEnabled, grabAllOrder, scanLimit, rateLimitDelay, defaultMonitoringMode, onSubmit],
[defaultFormatProfileId, checkInterval, concurrencyLimit, subtitleLanguages, grabAllEnabled, grabAllOrder, scanLimit, rateLimitDelay, defaultMonitoringMode, nfoEnabled, defaultView, onSubmit],
);
const platformLabel = platform === 'youtube' ? 'YouTube' : platform === 'soundcloud' ? 'SoundCloud' : platform;
const platformLabel = platform === 'youtube' ? 'YouTube' : platform === 'soundcloud' ? 'SoundCloud' : platform === 'generic' ? 'Generic' : platform;
return (
<form onSubmit={handleSubmit}>
@ -280,6 +286,41 @@ export function PlatformSettingsForm({
<span style={hintStyle}>Default monitoring mode for new channels from this platform.</span>
</div>
{/* Default View */}
<div style={fieldGroupStyle}>
<label htmlFor="ps-default-view" style={labelStyle}>Default View</label>
<select
id="ps-default-view"
value={defaultView}
onChange={(e) => setDefaultView(e.target.value as 'list' | 'poster' | 'table')}
style={selectStyle}
>
<option value="list">List</option>
<option value="poster">Poster</option>
<option value="table">Table</option>
</select>
<span style={hintStyle}>Default content view when browsing channels on this platform.</span>
</div>
{/* NFO Enabled */}
<div style={{ ...fieldGroupStyle, display: 'flex', alignItems: 'center', gap: 'var(--space-2)' }}>
<input
id="ps-nfo-enabled"
type="checkbox"
checked={nfoEnabled}
onChange={(e) => setNfoEnabled(e.target.checked)}
style={{
width: 16,
height: 16,
accentColor: 'var(--accent)',
cursor: 'pointer',
}}
/>
<label htmlFor="ps-nfo-enabled" style={{ fontSize: 'var(--font-size-sm)', color: 'var(--text-secondary)', cursor: 'pointer' }}>
Generate NFO sidecar files
</label>
</div>
{/* Action buttons */}
<div style={{ display: 'flex', justifyContent: 'flex-end', gap: 'var(--space-3)', marginTop: 'var(--space-5)' }}>
<button

149
src/frontend/src/pages/Settings.tsx
View file

@ -105,7 +105,6 @@ export function SettingsPage() {
const [checkInterval, setCheckInterval] = useState<number | ''>('');
const [concurrentDownloads, setConcurrentDownloads] = useState<number | ''>('');
const [outputTemplate, setOutputTemplate] = useState('');
const [nfoEnabled, setNfoEnabled] = useState(false);
const [timezone, setTimezone] = useState('UTC');
const [theme, setTheme] = useState<'dark' | 'light'>('dark');
const [settingsSaveFlash, setSettingsSaveFlash] = useState(false);
@ -134,7 +133,6 @@ export function SettingsPage() {
setCheckInterval(appSettings.checkInterval);
setConcurrentDownloads(appSettings.concurrentDownloads);
setOutputTemplate(appSettings.outputTemplate);
setNfoEnabled(appSettings.nfoEnabled);
setTimezone(appSettings.timezone);
setTheme(appSettings.theme);
}
@ -154,7 +152,6 @@ export function SettingsPage() {
(Number(checkInterval) !== appSettings.checkInterval ||
Number(concurrentDownloads) !== appSettings.concurrentDownloads ||
outputTemplate !== appSettings.outputTemplate ||
nfoEnabled !== appSettings.nfoEnabled ||
timezone !== appSettings.timezone ||
theme !== appSettings.theme);
@ -207,7 +204,6 @@ export function SettingsPage() {
checkInterval: Number(checkInterval),
concurrentDownloads: Number(concurrentDownloads),
outputTemplate,
nfoEnabled,
timezone,
theme,
},
@ -312,7 +308,7 @@ export function SettingsPage() {
// ── Platform Settings handlers ──
const KNOWN_PLATFORMS = ['youtube', 'soundcloud'] as const;
const KNOWN_PLATFORMS = ['youtube', 'soundcloud', 'generic'] as const;
const platformSettingsMap = useMemo(() => {
const map = new Map<string, PlatformSettings>();
@ -337,6 +333,8 @@ export function SettingsPage() {
subtitleLanguages: values.subtitleLanguages || null,
grabAllEnabled: values.grabAllEnabled,
grabAllOrder: values.grabAllOrder,
nfoEnabled: values.nfoEnabled,
defaultView: values.defaultView,
};
updatePlatformSettingsMutation.mutate(input, {
onSuccess: () => setEditingPlatform(null),
@ -357,7 +355,7 @@ export function SettingsPage() {
() =>
KNOWN_PLATFORMS.map((platform) => ({
platform,
label: platform === 'youtube' ? 'YouTube' : 'SoundCloud',
label: platform === 'youtube' ? 'YouTube' : platform === 'soundcloud' ? 'SoundCloud' : 'Generic',
settings: platformSettingsMap.get(platform) ?? null,
})),
[platformSettingsMap],
@ -369,17 +367,25 @@ export function SettingsPage() {
key: 'platform',
label: 'Platform',
width: '130px',
render: (row) => (
<span
style={{
...badgeBase,
color: row.platform === 'youtube' ? '#ff4444' : '#ff7700',
backgroundColor: row.platform === 'youtube' ? 'rgba(255, 68, 68, 0.1)' : 'rgba(255, 119, 0, 0.1)',
}}
>
{row.label}
</span>
),
render: (row) => {
const colorMap: Record<string, { color: string; bg: string }> = {
youtube: { color: '#ff4444', bg: 'rgba(255, 68, 68, 0.1)' },
soundcloud: { color: '#ff7700', bg: 'rgba(255, 119, 0, 0.1)' },
generic: { color: '#8b8d97', bg: 'rgba(139, 141, 151, 0.1)' },
};
const c = colorMap[row.platform] ?? colorMap.generic;
return (
<span
style={{
...badgeBase,
color: c.color,
backgroundColor: c.bg,
}}
>
{row.label}
</span>
);
},
},
{
key: 'formatProfile',
@ -433,6 +439,35 @@ export function SettingsPage() {
);
},
},
{
key: 'nfo',
label: 'NFO',
width: '70px',
render: (row) => {
const enabled = row.settings?.nfoEnabled ?? false;
return (
<span
style={{
...badgeBase,
color: enabled ? 'var(--success)' : 'var(--text-muted)',
backgroundColor: enabled ? 'var(--success-bg)' : 'var(--bg-hover)',
}}
>
{enabled ? 'On' : 'Off'}
</span>
);
},
},
{
key: 'defaultView',
label: 'View',
width: '80px',
render: (row) => (
<span style={{ color: 'var(--text-secondary)', fontSize: 'var(--font-size-sm)', textTransform: 'capitalize' }}>
{row.settings?.defaultView ?? 'list'}
</span>
),
},
{
key: 'actions',
label: '',
@ -1339,84 +1374,6 @@ export function SettingsPage() {
{templatePreview || '—'}
</div>
</div>
{/* NFO Sidecar toggle */}
<div
style={{
marginTop: 'var(--space-4)',
paddingTop: 'var(--space-4)',
borderTop: '1px solid var(--border)',
display: 'flex',
alignItems: 'center',
justifyContent: 'space-between',
}}
>
<div>
<label
htmlFor="nfo-enabled"
style={{
display: 'block',
fontSize: 'var(--font-size-sm)',
fontWeight: 500,
color: 'var(--text-primary)',
cursor: 'pointer',
}}
>
Generate NFO Files
</label>
<span style={{ fontSize: 'var(--font-size-xs)', color: 'var(--text-muted)' }}>
Write Kodi-compatible .nfo sidecar files alongside downloaded media
</span>
</div>
<label
style={{
position: 'relative',
display: 'inline-block',
width: 44,
height: 24,
flexShrink: 0,
}}
>
<input
id="nfo-enabled"
type="checkbox"
checked={nfoEnabled}
onChange={(e) => setNfoEnabled(e.target.checked)}
style={{
opacity: 0,
width: 0,
height: 0,
position: 'absolute',
}}
/>
<span
style={{
position: 'absolute',
cursor: 'pointer',
inset: 0,
backgroundColor: nfoEnabled ? 'var(--accent)' : 'var(--bg-hover)',
borderRadius: 12,
border: `1px solid ${nfoEnabled ? 'var(--accent)' : 'var(--border)'}`,
transition: 'background-color 0.2s, border-color 0.2s',
}}
>
<span
style={{
position: 'absolute',
content: '""',
height: 18,
width: 18,
left: nfoEnabled ? 22 : 2,
top: 2,
backgroundColor: '#fff',
borderRadius: '50%',
transition: 'left 0.2s',
boxShadow: '0 1px 3px rgba(0,0,0,0.2)',
}}
/>
</span>
</label>
</div>
</div>
</section>
@ -1664,7 +1621,7 @@ export function SettingsPage() {
{/* ── Platform Settings: Edit modal ── */}
<Modal
title={`${editingPlatform === 'youtube' ? 'YouTube' : editingPlatform === 'soundcloud' ? 'SoundCloud' : editingPlatform ?? ''} Settings`}
title={`${editingPlatform === 'youtube' ? 'YouTube' : editingPlatform === 'soundcloud' ? 'SoundCloud' : editingPlatform === 'generic' ? 'Generic' : editingPlatform ?? ''} Settings`}
open={!!editingPlatform}
onClose={() => setEditingPlatform(null)}
width={520}

6
src/server/routes/platform-settings.ts
View file

@ -9,7 +9,7 @@ import { Platform } from '../../types/index';
// ── JSON Schemas for Fastify Validation ──
const VALID_PLATFORMS = [Platform.YouTube, Platform.SoundCloud] as const;
const VALID_PLATFORMS = [Platform.YouTube, Platform.SoundCloud, Platform.Generic] as const;
const upsertPlatformSettingsBodySchema = {
type: 'object' as const,
@ -23,6 +23,8 @@ const upsertPlatformSettingsBodySchema = {
scanLimit: { type: 'integer' as const, minimum: 10, maximum: 1000 },
rateLimitDelay: { type: 'integer' as const, minimum: 0, maximum: 10000 },
defaultMonitoringMode: { type: 'string' as const, enum: ['all', 'future', 'existing', 'none'] },
nfoEnabled: { type: 'boolean' as const },
defaultView: { type: 'string' as const, enum: ['list', 'poster', 'table'] },
},
additionalProperties: false,
};
@ -79,6 +81,8 @@ export async function platformSettingsRoutes(fastify: FastifyInstance): Promise<
scanLimit?: number;
rateLimitDelay?: number;
defaultMonitoringMode?: 'all' | 'future' | 'existing' | 'none';
nfoEnabled?: boolean;
defaultView?: 'list' | 'poster' | 'table';
};
}>(
'/api/v1/platform-settings/:platform',

2
src/types/index.ts
View file

@ -189,6 +189,8 @@ export interface PlatformSettings {
scanLimit: number;
rateLimitDelay: number;
defaultMonitoringMode: MonitoringMode;
nfoEnabled: boolean;
defaultView: 'list' | 'poster' | 'table';
createdAt: string;
updatedAt: string;
}