* feat(namespace): add namespace for CJLU * feat(route): Add route for graduate school of CJLU 为中国计量大学研究生院添加路由 支持将`教师通知`和`研究生通知`页面转化为 RSS 订阅源 * doc: modify discription of some params 修改参数描述 * fix(radar rule): modify radar rule 修改 radar 规则,以正确提供订阅源 * fix: add exception handling 增加异常处理 * chore: optimize conditional logic 优化判断逻辑 * Update lib/routes/cjlu/yjsy/index.ts Co-authored-by: Tony <TonyRL@users.noreply.github.com> * fix(radar rule): list all source choices 在 radar 规则中列出全部的类型 修改行尾符为 LF * fix(example): correct example of the route 订正路由的案例 * chore: add missing namespace information * fix(mangadex): resolve incorrect route detection * chore: update route name and include myself as a maintainer * feat(mangadex): add token retrieval utility base on config * feat(mangadex): add utility to retrieve user configurations Added a utility function `getFilteredLanguages` to retrieve filtered languages based on the current user's configuration. * feat: add `getMangaMeta` utility to retrive metadata for a manga * refactor: add utility to retrive chapter info for a manga Original implementation by @vzz64 was embedded in modules. Extracted the common logic into a standalone function for better code reusability and maintainability. * refactor(feed util): move the fallback logic into function Add a docstring to explain its usage * doc(access util): add docstrings for key function * refactor: purify result of function Change result type from object to array by remove `total` param. * feat(feed util): add support for alternative parameter type - Add docstring for util functions - Add a new combination function - Improve code type inference * refactor: move constants to separate files for better organization * feat: modify the route for single manga - **important**: add a prefix to the route for space for other routes in namespace, not compatiable to former route - use integrated utility to retrieve details of a single manga * refactor: move `token expire time` to constant * docs(access): add Error docstring * chore: make cover became thumbnail to save bandwidth and better display * feat: add new route for user follow's list - support reading, plan to read etc. - add new optional param to utility function * fix: improve perfomance in retrieving manga's meta data - if cover is needed, use the optional param `includes` to fetch in one request * refactor: rearrange code - skip some code for branch without cover needed * docs: add description for route * docs: add a detailed param description for route - offer a default value for param * feat: add a new constant * feat: seperate util-function for better organization - add docstring for `toQueryString` * feat: add new utility function to fetch manga meta data in batch * fix: use dynamic key to cache result - otherwise it may get wrong result with diffrent types - rearrange the code * feat: add a new route for all user's followed mangas * chore: add parameters' desctiption - offer a more detailed example - use local constant to maintance limit - change some code's style * style: change style in using utility function * style: refactor query string construction for improved readability * style: change a variable's name * feat: add new route for sepecific mdlist feed * fix: use correct time for pubDate * fix: use `image` prop to display thumbnail instead of `description` * refactor(mangadex): improve access token retrieval logic and handle refresh token errors * refactor(mangadex): replace getMangaMeta with getMangaMetaByIds for improved efficiency * chore: modify route's decription * fix: remove unnecessary nullish coalescing in description assignment * fix: update access token retrieval to use client ID and secret instead of username and password * fix: correct spellings in definition * chore: remove unnecessary code * fix: dedupe ids before fetch manga metas - add `limit` param to get the full response * fix: remove wrong suffix * fix: remove unnecessary code * chore: remove unnessary code * fix: set manga and config feed's cache to not refreshable * fix: remove filteredLanguages option * fix: remove filteredLanguages option * fix: add sort operation after dedupe * style: add trailing comma * fix: remove common params * fix: remove unnecessary code * fix: remove route's unnecessary name prefix * fix: change TTL for hot caches * fix: remove docs for non-exist config * refactor: fix lint issue for better readability * fix: ensure cover image is only set if cover filename exists ---------
185 lines
6.7 KiB
TypeScript
185 lines
6.7 KiB
TypeScript
import got from '@/utils/got';
|
|
import { config } from '@/config';
|
|
import cache from '@/utils/cache';
|
|
import md5 from '@/utils/md5';
|
|
import { getFilteredLanguages } from './_profile';
|
|
import { toQueryString, firstMatch } from './_utils';
|
|
import constants from './_constants';
|
|
|
|
/**
|
|
* Retrieves the title, description, and cover of a manga.
|
|
*
|
|
* @author chrisis58, vzz64
|
|
* @param id manga id
|
|
* @param lang language(s), absent for default
|
|
* @param needCover whether to fetch cover
|
|
* @returns title, description, and cover of the manga
|
|
*/
|
|
const getMangaMeta = async (id: string, needCover: boolean = true, lang?: string | string[]) => {
|
|
const includes = needCover ? ['cover_art'] : [];
|
|
|
|
const rawMangaMeta = (await cache.tryGet(`mangadex:manga-meta:${id}`, async () => {
|
|
const { data } = await got.get(
|
|
`${constants.API.MANGA_META}${id}${toQueryString({
|
|
includes,
|
|
})}`
|
|
);
|
|
|
|
if (data.result === 'error') {
|
|
throw new Error(data.errors[0].detail);
|
|
}
|
|
return data.data;
|
|
})) as any;
|
|
|
|
const relationships = (rawMangaMeta.relationships || []) as Array<{ type: string; id: string; attributes: any }>;
|
|
|
|
const languages = [
|
|
...(typeof lang === 'string' ? [lang] : lang || []),
|
|
...(await getFilteredLanguages()),
|
|
rawMangaMeta.attributes.originalLanguage, // fallback to original language
|
|
].filter(Boolean);
|
|
|
|
// combine title and altTitles
|
|
const titles = {
|
|
...rawMangaMeta.attributes.title,
|
|
...Object.fromEntries(rawMangaMeta.attributes.altTitles.flatMap((element) => Object.entries(element))),
|
|
};
|
|
|
|
const title = firstMatch(titles, languages) as string;
|
|
|
|
const description = firstMatch(rawMangaMeta.attributes.description, languages) as string;
|
|
|
|
if (!needCover) {
|
|
return { title, description };
|
|
}
|
|
|
|
const coverFilename = relationships.find((relationship) => relationship.type === 'cover_art')?.attributes.fileName + '.512.jpg';
|
|
const cover = `${constants.API.COVER_IMAGE}${id}/${coverFilename}`;
|
|
|
|
return { title, description, cover };
|
|
};
|
|
|
|
/**
|
|
* Retrieves the title, description, and cover of multiple manga.
|
|
* TODO: Retrieve page by page to avoid meeting the length limit of URL.
|
|
*
|
|
* @param ids manga ids
|
|
* @param needCover whether to fetch cover
|
|
* @param lang language(s), absent for default
|
|
* @returns a map of manga id to title, description, and cover
|
|
* @usage const mangaMetaMap = await getMangaMetaByIds(['f98660a1-d2e2-461c-960d-7bd13df8b76d']);
|
|
*/
|
|
export async function getMangaMetaByIds(ids: string[], needCover: boolean = true, lang?: string | string[]): Promise<Map<string, { id: string; title: string; description: string; cover?: string }>> {
|
|
const deDuplidatedIds = [...new Set(ids)].sort();
|
|
const includes = needCover ? ['cover_art'] : [];
|
|
|
|
const rawMangaMetas = (await cache.tryGet(
|
|
`mangadex:manga-meta:${md5(deDuplidatedIds.join(''))}`, // shorten the key
|
|
async () => {
|
|
const { data } = await got.get(
|
|
constants.API.MANGA_META.slice(0, -1) +
|
|
toQueryString({
|
|
ids: deDuplidatedIds,
|
|
includes,
|
|
limit: deDuplidatedIds.length,
|
|
})
|
|
);
|
|
|
|
if (data.result === 'error') {
|
|
throw new Error('Failed to retrieve manga meta from MangaDex API.');
|
|
}
|
|
return data.data;
|
|
}
|
|
)) as Array<any>;
|
|
|
|
const languages = [...(typeof lang === 'string' ? [lang] : lang || []), ...(await getFilteredLanguages())].filter(Boolean);
|
|
|
|
const map = new Map<string, { id: string; title: string; description: string; cover?: string }>();
|
|
for (const rawMangaMeta of rawMangaMetas) {
|
|
const id = rawMangaMeta.id;
|
|
|
|
const titles = {
|
|
...rawMangaMeta.attributes.title,
|
|
...Object.fromEntries(rawMangaMeta.attributes.altTitles.flatMap((element) => Object.entries(element))),
|
|
};
|
|
|
|
const title = firstMatch(titles, [...languages, rawMangaMeta.attributes.originalLanguage]) as string;
|
|
|
|
const description = firstMatch(rawMangaMeta.attributes.description, languages) as string;
|
|
|
|
let cover: string | undefined;
|
|
let manga = { id, title, description, cover };
|
|
|
|
if (needCover) {
|
|
const coverFilename = rawMangaMeta.relationships.find((relationship) => relationship.type === 'cover_art')?.attributes.fileName;
|
|
if (coverFilename) {
|
|
cover = `${constants.API.COVER_IMAGE}${rawMangaMeta.id}/${coverFilename}.512.jpg`;
|
|
manga = { ...manga, cover };
|
|
}
|
|
}
|
|
|
|
map.set(id, manga);
|
|
}
|
|
return map;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the chapters of a manga.
|
|
*
|
|
* @author chrisis58, vzz64
|
|
* @param id manga id
|
|
* @param lang language(s), absent for default
|
|
* @returns chapters of the manga
|
|
*/
|
|
const getMangaChapters = async (id: string, lang?: string | string[], limit?: number) => {
|
|
const languages = new Set([...(typeof lang === 'string' ? [lang] : lang || []), ...(await getFilteredLanguages())].filter(Boolean));
|
|
|
|
const url = `${constants.API.MANGA_META}${id}/feed${toQueryString({
|
|
order: {
|
|
publishAt: 'desc',
|
|
},
|
|
limit: limit || 100,
|
|
translatedLanguage: languages,
|
|
})}`;
|
|
|
|
const chapters = (await cache.tryGet(
|
|
`mangadex:manga-chapters:${id}`,
|
|
async () => {
|
|
const { data } = await got.get(url);
|
|
|
|
if (data.result === 'error') {
|
|
throw new Error(data.errors[0].detail);
|
|
}
|
|
|
|
return data.data;
|
|
},
|
|
config.cache.routeExpire,
|
|
false
|
|
)) as any;
|
|
|
|
if (!chapters) {
|
|
return [];
|
|
}
|
|
|
|
return chapters.map((chapter) => ({
|
|
title: [chapter.attributes.volume ? `Vol. ${chapter.attributes.volume}` : null, chapter.attributes.chapter ? `Ch. ${chapter.attributes.chapter}` : null, chapter.attributes.title].filter(Boolean).join(' '),
|
|
link: `${constants.API.MANGA_CHAPTERS}${chapter.id}`,
|
|
pubDate: new Date(chapter.attributes.publishAt),
|
|
})) as Array<{ title: string; link: string; pubDate: Date }>;
|
|
};
|
|
|
|
/**
|
|
* Retrieves the title, description, cover, and chapters of a manga.
|
|
* Cominbation of getMangaMeta and getMangaChapters.
|
|
*
|
|
* @param id manga id
|
|
* @param lang language, absent for default
|
|
* @returns title, description, cover, and chapters of the manga
|
|
*/
|
|
const getMangaDetails = async (id: string, needCover: boolean = true, lang?: string | string[]) => {
|
|
const [meta, chapters] = await Promise.all([getMangaMeta(id, needCover, lang), getMangaChapters(id, lang)]);
|
|
return { ...meta, chapters };
|
|
};
|
|
|
|
export { getMangaMeta, getMangaChapters, getMangaDetails };
|