lnreader-plugins/types/plugin.ts

import { FilterToValues, Filters } from "@libs/filterInputs";
import { languages } from "@libs/languages";
export namespace Plugin {
    export interface ChapterItem {
        name: string;
        path: string;
        /**
         * "YYYY-MM-DD" format or ISO string format
         * ```js
         * chapter.releaseTime = '2023-12-02';
         * chapter.releaseTime = new Date(2023, 12, 02).toISOString();
         * ```
         * or just a string
         */
        releaseTime?: string | null;
        chapterNumber?: number;
        /**
         * For novel without pages only
         */
        page?: string;
    }
    export interface NovelItem {
        name: string;
        path: string;
        cover?: string;
    }
    export interface SourceNovel extends NovelItem {
        /** Comma separated genre list */
        genres?: string;
        summary?: string;
        author?: string;
        artist?: string;
        status?: string;
        chapters?: ChapterItem[];
    }

    export interface SourcePage {
        chapters: ChapterItem[];
        latestChapter?: ChapterItem;
    }

    export interface PopularNovelsOptions<
        Q extends Filters | undefined = Filters | undefined
    > {
        showLatestNovels?: boolean;
        filters: Q extends undefined ? undefined : FilterToValues<Q>;
    }
    export interface PluginItem {
        id: string;
        name: string;
        lang: (typeof languages)[keyof typeof languages];
        version: string;
        requirePath: string;
        icon: string;
    }

    export interface PluginBase {
        id: string;
        name: string;
        /**
         * Relative path without icon. E.g:
         * ```js
         * "src/vi/hakolightnovel/icon.png"
         * ```
         */
        icon: string;
        site: string;
        filters?: Filters;
        version: string;
        popularNovels(
            pageNo: number,
            options: PopularNovelsOptions<Filters>
        ): Promise<NovelItem[]>;
        /**
         * 
         * @param novelPath 
         * @returns novel metadata and its first page
         */
        parseNovel(novelPath: string): Promise<SourceNovel>;
        parseChapter(chapterPath: string): Promise<string>;
        searchNovels(searchTerm: string, pageNo: number): Promise<NovelItem[]>;
        /**
         *
         * @param url Image url
         * @returns {Promise<string|undefined>} Base64 of image
         * @example
         * ```ts
         *  const headers = {
         *      Referer: "https://ln.hako.vn",
         *   };
         *  return await fetchFile(url, { headers: headers });
         * ```
         */
        fetchImage(url: string): Promise<string | undefined>;
    }

    export interface PagePlugin extends PluginBase {
        parseNovel(novelPath: string): Promise<SourceNovel & {totalPages: number}>;
        /**
         * @returns
         * If site doesn't have ascending order. return `chapters, latestChapter`
         * to let app decide the corresponding behavior.
         * Otherwise, only `chapters` is enough
         */
        parsePage(novelPath: string, page: string): Promise<SourcePage>;
    }
}