Full TS for Plugins (#538)

* remove lang, descrription in plugin script * remove languages import * Update README.md * fix: missing lang * clean: remove description * feat(Add Sources) (#15) * add many sources * add showToast * feat(Add Source): (#16) * add source * remove descriptions * Early Novel & Fast Novel (#1) * some more plugin * plugin * try something new * yes * try yes * genres is plural * fastnovel full fix * testings * early check * earlynovel fixed * showToast check * earlynovel done * fastnovel fixe * again * showToasts again * fix for fastnovel * done * for pr * Update freenovelupdates.js * MTL Reader and MTL Novel (#2) * first * test * wops * mtlreaders * ok * for PR * Nitro Scans and Novel Hold (#3) * start feature * more feature * something * eslint * yes * maybe * wa * asdasd * amazing * change it up * for pr * WPmangastream and Novelfull (#4) (#17) * source generation * fix json parse error * update plguins * delete fetchApi, nobleMTL (.js) * delete showToast.js * Typescript Support (#18) * Initial TS Config * Initial TS Config * Fix most errors * Fix test webserver * Fix webserver isPlugin not working * Fix typos * Add check if plugins have all the fields * Move exports.protected to the bottom of the plugin * Change username, reponame and branchname * Fix no exports error * Fix type * Fix typo in tsc_fix * Remove const from exports to not re-define consts * Readd const becuause exports may not exist. * Fix plugins to work in-app * Fix NobleMTL * Remove fix_ts.ts * Change template.ts * delete cheerio_space * move api into ./testweb * remove js dir * remove js dir (again) * remove ./js (again) * init multisrc generator (test) * remove module.exports in libs * madara generator * update template * rename generator, TS for hako * fix icon url for madara * fix icon for madara (again) * update Readme, nodemon * export default for all libs * fix madara novelurl * update: pluginId, name, filename for madara * feat: check same id error * update: precommit, fix: require.default * Revert "update: precommit, fix: require.default" This reverts commit c642c5c72241f13eccfe417210c22272c4739ffa. * Port all plugins to ts (#19) - fix cheerio - remove export default - fix spelling * update template * add multisrc noveltl, update generator param, fix web search * fix undefined id for Snailulitka * add rulate multisrc, fix max length textarea * add readwn multisrc * delete: erolate and rulate are in multisrc * Change broken extension and show error on commit for those files (#20) * Change to .broken.ts and show error on commit for those files * remove novelStatus * fix: wrong id in github action * remove mangastream multisrc * update icon for readwn multisrc --------- Co-authored-by: K1ngfish3r <trulyihu@gmail.com> Co-authored-by: Marcin Majewski <skilletssgames@gmail.com>
2023-08-17 10:19:45 +07:00
parent e444031c25
commit e602df44c8
306 changed files with 58843 additions and 14008 deletions
@@ -0,0 +1,111 @@
+import { Filter } from "@libs/filterInputs";
+import { languages } from "@libs/languages";
+import { NodeFetchParams } from "@libs/nodeFetch";
+
+export namespace Chapter {
+    export interface Item {
+        name: string;
+        url: string;
+        releaseTime?: string | null;
+    }
+    export interface instance {
+        sourceId: number;
+        novelUrl: string;
+        chapterUrl: string;
+        name?: string;
+        chapterText?: string;
+    }
+}
+
+export namespace Novel {
+    export interface Item {
+        name: string;
+        url: string;
+        cover?: string;
+    }
+    export interface instance {
+        url: string;
+        name?: string;
+        cover?: string;
+        genres?: string;
+        summary?: string;
+        author?: string;
+        status?: string;
+        chapters?: Chapter.Item[];
+    }
+}
+
+export namespace Plugin {
+    export interface Options {
+        showLatestNovels?: boolean;
+        filters?: Record<string, string | string[]>;
+    }
+    export interface Info {
+        id: string;
+        name: string;
+        lang: (typeof languages)[keyof typeof languages];
+        version: string;
+        requirePath: string;
+    }
+    export interface instance {
+        id: string;
+        name: string;
+        version: string;
+        icon: string;
+        site: string;
+        protected?: boolean;
+        popularNovels: popularNovels;
+        parseNovelAndChapters: parseNovelAndChapters;
+        parseChapter: parseChapter;
+        searchNovels: searchNovels;
+        fetchImage: fetchImage;
+        filters?: Filter[];
+    }
+    export type popularNovels = (
+        page: number,
+        options: Plugin.Options
+    ) => Promise<PopularNovelsResponse>;
+    export type PopularNovelsResponse = Novel.Item[];
+    export type parseNovelAndChapters = (
+        novelUrl: string
+    ) => Promise<Novel.instance>;
+    export type parseChapter = (chapterUrl: string) => Promise<string | null>;
+    export type searchNovels = (searchTerm: string) => Promise<Novel.Item[]>;
+    export type fetchImage = (
+        ...params: NodeFetchParams
+    ) => Promise<string | undefined>;
+}
+
+export const isPlugin = (p: any): p is Plugin.instance => {
+    const pl = p as Plugin.instance;
+
+    const errorOut = (key: string) => {
+        console.error(`Plugin ${pl.name} doesn't have ${key}!`);
+        return false;
+    };
+
+    const required_funcs: (keyof Plugin.instance)[] = [
+        "popularNovels",
+        "parseNovelAndChapters",
+        "parseChapter",
+        "searchNovels",
+        "fetchImage",
+    ];
+    for (let i = 0; i < required_funcs.length; i++) {
+        const key = required_funcs[i];
+        if (!pl[key] || typeof pl[key] !== "function") return errorOut(key);
+    }
+    const requireds_fields: (keyof Plugin.instance)[] = [
+        "id",
+        "name",
+        "version",
+        "icon",
+        "site",
+    ];
+    for (let i = 0; i < requireds_fields.length; i++) {
+        const key = requireds_fields[i];
+        if (pl[key] === undefined) return errorOut(key);
+    }
+
+    return true;
+};
@@ -0,0 +1,5 @@
+import { Plugin } from "@typings/plugin";
+
+export type PluginList = {
+    [key: string]: Plugin.Info[];
+};