Files
RSSHub/lib/routes/mangadex/_access.ts
T
chris zheng 62ae012cc7 feat(route/mangadex): add three new routes and modify one old route for mangadex.org (#18269)
* 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

---------
2025-06-06 22:29:13 +08:00

112 lines
3.8 KiB
TypeScript

import got from '@/utils/got';
import cache from '@/utils/cache';
import { config } from '@/config';
import ConfigNotFoundError from '@/errors/types/config-not-found';
import constants from './_constants';
import { FetchError } from 'ofetch';
/**
* Retrieves an access token.
*
* @important Ensure the request includes a User-Agent header.
* @throws {ConfigNotFoundError} If the required configuration is missing.
* The following credentials are mandatory:
* - `client ID` and `client secret`
* - One of the following:
* - `username` and `password`
* - `refresh token`
* @throws {FetchError} If the request fails.
* - 400 Bad Request: If the `refresh token` or other credentials are invalid.
* @returns {Promise<string>} A promise that resolves to the access token.
*/
const getToken = () => {
if (!config.mangadex.clientId || !config.mangadex.clientSecret) {
throw new ConfigNotFoundError('Cannot get access token since MangaDex client ID or secret is not set.');
}
return cache.tryGet(
'mangadex:access-token',
async () => {
if (!config.mangadex.refreshToken) {
return getAccessTokenByUserCredentials();
}
try {
return await getAccessTokenByRefreshToken();
} catch (error) {
if (error instanceof FetchError && error.statusCode === 400) {
// If the refresh token is invalid, try to get a new one with the user credentials
return getAccessTokenByUserCredentials();
}
throw error;
}
},
constants.TOKEN_EXPIRE,
false
);
};
const getAccessTokenByUserCredentials = async () => {
if (!config.mangadex.clientId || !config.mangadex.clientSecret) {
throw new ConfigNotFoundError('Cannot get access token since MangaDex client ID or secret is not set.');
}
if (!config.mangadex.username || !config.mangadex.password) {
throw new ConfigNotFoundError('Cannot get refresh token since MangaDex username or password is not set');
}
const response = await got.post(constants.API.TOKEN, {
headers: {
'User-Agent': config.trueUA,
},
form: {
grant_type: 'password',
username: config.mangadex.username,
password: config.mangadex.password,
client_id: config.mangadex.clientId,
client_secret: config.mangadex.clientSecret,
},
});
const refreshToken = response?.data?.refresh_token;
const accessToken = response?.data?.access_token;
if (!refreshToken || !accessToken) {
throw new Error('Failed to retrieve refresh token from MangaDex API.');
}
config.mangadex.refreshToken = refreshToken; // cache the refresh token
return accessToken;
};
const getAccessTokenByRefreshToken = async () => {
if (!config.mangadex.clientId || !config.mangadex.clientSecret) {
throw new ConfigNotFoundError('Cannot get access token since MangaDex client ID or secret is not set.');
}
if (!config.mangadex.refreshToken) {
throw new ConfigNotFoundError('Cannot get access token since MangaDex refresh token is not set.');
}
const response = await got.post(constants.API.TOKEN, {
headers: {
'User-Agent': config.trueUA,
},
form: {
grant_type: 'refresh_token',
refresh_token: config.mangadex.refreshToken,
client_id: config.mangadex.clientId,
client_secret: config.mangadex.clientSecret,
},
});
const accessToken = response?.data?.access_token;
if (!accessToken) {
throw new Error('Failed to retrieve access token from MangaDex API.');
}
return accessToken;
};
export default getToken;