Skip to content

A self-hosted media server and file management system

5.2 KB
Raw Blame
import type { FolderTagResource, VideoTagResource } from '@/contracts/tags';
import type { MediaTypeValue } from '@/types/types';
import type { UserResource } from '@/contracts/users';

export interface CategoryResource {
    id: number;
    name: string;
    folders: FolderResource[];
    folders_count: number;
    videos_count?: number;
    total_size: number;
    default_folder_id?: number;
    created_at?: string;
    last_scan: number;
    is_private?: boolean;
    downloads_enabled: boolean;
    downloads_require_auth: boolean;
    storyboard_enabled: boolean;
    fonts_enabled: boolean;
}

//#region Folders
export interface FolderResource {
    id: number;
    category_id: number;
    name: string;
    path: string;
    created_at?: string;
    last_scan: number;

    title: string;
    episodes?: number;
    file_count: number;
    completion_count: number;
    total_size: number;
    is_majority_audio: boolean;
    videos: VideoResource[];
    series?: SeriesResource;
    scanned_at?: string;
    updated_at?: string;
    edited_at?: string;
    released_at?: string;
}

export interface SeriesResource {
    id: number;
    uuid?: string;
    folder_id?: number;
    editor_id?: number;
    title?: string;
    description?: string;
    studio?: string;
    rating?: number;
    seasons?: number;
    episodes?: number;
    films?: number;
    avg_intro_duration: number;
    started_at?: string;
    ended_at?: string;
    thumbnail_url?: string;
    folder_tags?: FolderTagResource[];
    created_at?: string;
    updated_at?: string;
    edited_at?: string;
    downloads_enabled: boolean;
    poster_image?: ImageResource;
    banner_image?: ImageResource;
    primary_banner_id?: number;
    images: ImageResource[];

    related_series: SeriesRelation[];

    library_id?: number;
    library_name?: string;
}

//#endregion

//#region Media
export interface MetadataResource {
    // Commented out attributes are duplicated in VideoResource?

    // Id
    id: number;
    uuid?: string;

    // Fk
    video_id?: number;
    editor_id?: number;

    // User Editable
    title?: string;
    // description?: string;
    lyrics?: string;
    // episode?: number;
    // season?: number;

    poster_image?: ImageResource;
    images?: ImageResource[];

    artist?: string;
    album?: string;
    // released_at?: string;
    // intro_start?: number;
    // intro_duration?: number;
    // video_tags?: VideoTagResource[];

    // API Editable
    // view_count?: number;

    // FFmpeg Generated
    duration?: number;
    // file_size?: number;
    mime_type?: string;
    codec?: string;
    bitrate?: number;
    resolution_width?: number;
    resolution_height?: number;
    frame_rate?: number;
    media_type: MediaTypeValue;

    // Date info
    created_at?: string;
    // updated_at?: string;
    edited_at?: string;

    file_scanned_at?: string;
    file_modified_at?: string;
    first_file_modified_at?: string;
    subtitles_scanned_at?: string;
    fonts_scanned_at?: string;
}

export interface VideoResource {
    id: number;
    name: string;
    path: string;
    title?: string;
    description?: string;
    duration?: number;
    episode?: number;
    season?: number;
    artist?: string;
    album?: string;
    view_count: number;
    file_size?: number;
    video_tags: VideoTagResource[];
    intro_start?: number;
    intro_duration?: number;
    created_at: string;
    released_at?: string;
    updated_at?: string;
    file_modified_at?: string;
    edited_at?: string;
    metadata?: MetadataResource;
    subtitles: SubtitleResource[];
    storyboard?: StoryboardResource;
    progress_offset: number;
    progress_percentage: number;
    progress_created_at?: string;
    progress_updated_at?: string;
    completion_count: number;
    last_completed_at?: string;

    folder_id?: number;
    library_id?: number;

    url?: string;

    folder_name?: string;
    library_name?: string;

    fonts?: string[];
}

export interface SubtitleResource {
    id: number;
    track_id: number;
    metadata_uuid: string;
    language?: string;
    title?: string;
    codec?: string;
    is_default: boolean;
    is_forced: boolean;
}

export interface FontResource {
    file_name: string;
    path: string;
}

export interface StoryboardResource {
    tile_rows: number;
    tile_cols: number;
    tile_width: number;
    tile_height: number;
    interval_seconds: number;
    path?: string;
}

export interface ImageResource {
    id: number;
    path: string;
    type: ImageType;
    source: ImageSource;
    blur_hash?: string;
    width?: number;
    height?: number;
    size?: number;
    user_id?: number;
    created_at?: string;
    replaced_at?: string;
    user?: UserResource;
}

export type ImageType = 'poster' | 'banner' | 'preview' | 'avatar';

export type ImageSource = 'generated' | 'uploaded' | 'api' | 'url' | 'downloaded' | 'embedded' | 'legacy';

export interface SeriesSizeHistory {
    id: number;
    total_bytes: number;
    file_count: number;
    recorded_at: string;
}

export type SeriesRelationType = 'sequel' | 'prequel' | 'spinoff' | 'side_story' | 'alternative' | 'summary' | 'soundtrack' | 'related' | 'parent';

export interface SeriesRelation {
    type: SeriesRelationType;
    label: string;
    folder: FolderResource;
}