picacomic-api
/
0.1.12
picacomic-api 0.1.12
Install from the command line:
Learn more about npm packages
$ npm install @l2studio/picacomic-api@0.1.12
Install via package.json:
"@l2studio/picacomic-api": "0.1.12"
About this version
- English
- 简体中文
A library for PicaComic http web api
npm install --save @l2studio/picacomic-api
# or
pnpm i @l2studio/picacomic-apiBy default, the constructor does not need parameters.
import { PicaComicAPI } from '@l2studio/picacomic-api'
class PicaComicAPI(opts?: Partial<Options>) {
public readonly fetch: typeof got
public readonly options: Readonly<Options>
}type Options = {
timeout?: number // http request timeout (optional)
proxy?: { // http proxy (optional)
host: string // proxy host (required)
port: number // porxy port (required)
}
app?: { // PicaComic app client options (optional)
api: string
apiKey: string
signatureKey: string
accept: string
channel: '1' | '2' | '3'
version: string
uuid: string
platform: string
buildVersion: string
userAgent: string
imageQuality: 'original' | 'low' | 'medium' | 'high'
}
// Callback function used to re-authenticate and return a new token when the token is invalid. (optional)
// Example:
// async reauthorizationTokenCallback (self) {
// console.log('Token invalid, re-authenticate...')
// return await self.signIn({
// email : 'your picacomic account email',
// password: 'your picacomic account password'
// })
// }
reauthorizationTokenCallback?: (self: PicaComicAPI) => string | undefined | Promise<string | undefined>
}class PicaComicError extends Error {
readonly cause: got.HttpError | Error
readonly code: number
readonly error: string
readonly message: string
readonly detail?: string
}.register
/**
* Register a PicaComic account with the given payload.
*
* @param payload - {
* name - Nickname (2 - 50 characters)
* email - Email (Allow: [0-9 a-z . _])
* password - Password (Greater than 8 characters)
* question1 - Security Question 1
* question2 - 2
* question3 - 3
* answer1 - Security question 1 answer
* answer2 - 2 answer
* answer3 - 3 answer
* birthday - Birthday ('YYYY-MM-DD' | Date | Milliseconds) Need to be 18 years or older
* gender - Gender ('m' | 'f' | 'bot')
* }
* @return Response
*/
PicaComicAPI.prototype.register(payload: {
name: string
email: string
password: string
question1: string
question2: string
question3: string
answer1: string
answer2: string
answer3: string
birthday: string | Date | number
gender: 'm' | 'f' | 'bot'
}): Promise<Response<void>>.signIn
/**
* Sign in to the PicaComic account with the given email and password payload.
*
* @param payload - Email and password payload
* @return Access token
*/
PicaComicAPI.prototype.signIn(payload: { email: string, password: string }): Promise<string>.punchIn
/**
* Punch in to the PicaComic account with the given access token payload.
*
* @param payload - Access token payload
* @return PunchInResponse
*/
PicaComicAPI.prototype.punchIn(payload: { token: string }): Promise<PunchInResponse>.fetchUserProfile
/**
* Fetch user profile using the given access token payload.
*
* @param payload - Access token payload
* @return User
*/
PicaComicAPI.prototype.fetchUserProfile(payload: { token: string }): Promise<User>.fetchUserFavourite
/**
* Fetch user favourite comics using the given payload.
*
* @param payload - {
* token - Access token
* page - Page number (optional)
* sort - Sorting type (optional)
* }
* @return Comics
*/
PicaComicAPI.prototype.fetchUserFavourite(payload: { token: string, page?: number, sort?: ComicSort }): Promise<Comics>.fetchCategories
/**
* Fetch all categories using the given access token payload.
*
* @param payload - Access token payload
* @return Category[]
*/
PicaComicAPI.prototype.fetchCategories(payload: { token: string }): Promise<Category[]>.fetchComics
/**
* Fetch comics using the given payload.
*
* @param payload - {
* token - Access token
* category - Specify category name (e.g.: 'Cosplay')
* page - Page number (optional)
* sort - Sorting type (optional)
* }
* @return Comics
*/
PicaComicAPI.prototype.fetchComics(payload: { token: string, category: string, page?: number, sort?: ComicSort }): Promise<Comics>.fetchComic
/**
* Fetch comic info using the given payload.
*
* @param payload - {
* token - Access token
* id - Specify comic id
* }
* @return ComicInfo
*/
PicaComicAPI.prototype.fetchComic(payload: { token: string, id: string }): Promise<ComicInfo>.fetchComicComments
/**
* Fetch comic comments using the given payload.
*
* @param payload - {
* token - Access token
* comicId - Specify comic id
* page - Page number (optional)
* }
* @return ComicComments
*/
PicaComicAPI.prototype.fetchComicComments(payload: { token: string, comicId: string, page?: number }): Promise<ComicComments>.fetchComicEpisodes
/**
* Fetch comic episodes using the given payload.
*
* @param payload - {
* token - Access token
* comicId - Specify comic id
* page - Page number (optional)
* }
* @return ComicEpisodes
*/
PicaComicAPI.prototype.fetchComicEpisodes(payload: { token: string, comicId: string, page?: number }): Promise<ComicEpisodes>.fetchComicEpisodePages
/**
* Fetch pages of the specified comic episode using the given payload.
*
* @param payload - {
* token - Access token
* comicId - Specify comic id
* epsOrder - Specify episode order of the comic
* page - Page number (optional)
* }
* @return ComicEpisodePages
*/
PicaComicAPI.prototype.fetchComicEpisodePages(payload: { token: string, comicId: string, epsOrder: number, page?: number }): Promise<ComicEpisodePages>.stringifyImageUrl
/**
* Stringify the given media image data into image url.
*
* @param payload - {
* path - Path name
* fileServer - File server (Optional)
* }
* @return Stringify image url
*/
PicaComicAPI.prototype.stringifyImageUrl(payload: { path: string, fileServer?: string }): string.fetchImage
/**
* Fetch image from the given media image data.
*
* @param payload - {
* path - Path name
* fileServer - File server (Optional)
* }
* @return Duplex (Got stream)
*/
PicaComicAPI.prototype.fetchImage(payload: { path: string, fileServer?: string }): Promise<Duplex>.search
/**
* Search comics using the given payload.
*
* @param payload - {
* token - Access token
* keyword - Keyword
* categories - Specify category name array (e.g.: ['Cosplay']) (optional)
* page - Page number (optional)
* sort - Sorting type (optional)
* }
* @return Comics
*/
PicaComicAPI.prototype.search(payload: { token: string, keyword: string, categories?: string[], page?: number, sort?: ComicSort }): Promise<Comics>.switchComicLike
/**
* Switch the comic as like or unlike using the given payload.
*
* @param payload - {
* toke - Access token
* id - Comic id
* }
* @return 'like' | 'unlike'
*/
PicaComicAPI.prototype.switchComicLike(payload: { token: string, id: string }): Promise<'like' | 'unlike'>.switchComicFavourite
/**
* Switch the comic as favourite or un_favourite using the given payload.
*
* @param payload - {
* toke - Access token
* id - Comic id
* }
* @return 'favourite' | 'un_favourite'
*/
PicaComicAPI.prototype.switchComicFavourite(payload: { token: string, id: string }): Promise<'favourite' | 'un_favourite'>.setUserProfileSlogan
/**
* Set the slogan of the user profile with the given payload.
*
* @param payload - {
* toke - Access token
* slogan - Slogan (Cannot be blank)
* }
* @return Response
*/
PicaComicAPI.prototype.setUserProfileSlogan(payload: { token: string, slogan: string }): Promise<Response<void>>The service is just a wrapper for a single account operation, and does not need to handle the problem of token invalidation by itself.
Note: Service does not provide
registerandsignInfunctions.
import { PicaComicService } from '@l2studio/picacomic-api'
class PicaComicService(opts: ServiceOptions) {
public readonly api: PicaComicAPI
public readonly email: string
public readonly password: string
public readonly onReauthorizationToken?: (token: string) => void | Promise<void>
public token: string
}type ServiceOptions = Partial<Omit<Options, 'reauthorizationTokenCallback'>> & {
email: string // PicaComic account email
password: string // PicaComic account password
token?: string // PicaComic account access token (Optional)
// Callback function for re-authenticate and consuming a new token when the token is invalid. (Optional)
// Example:
// onReauthorizationToken (token) {
// console.log('New token:', token)
// fs.writeFileSync('token.txt', token)
// }
onReauthorizationToken?: (token: string) => void | Promise<void>
}When the token expires, it will re-login and renew the token and persistence. No need to provide token every time.
import { PicaComicService } from '@l2studio/picacomic-api'
import path from 'path'
import fs from 'fs'
const tokenFile = path.join(__dirname, '.token') // Persistent token
const picacomic = new PicaComicService({
email : 'your picacomic email',
password: 'your picacomic password',
token: fs.readFileSync(tokenFile, 'utf8'),
onReauthorizationToken (token) {
console.log('New token:', token)
fs.writeFileSync(tokenFile, token) // Update persistent token
}
})
;(async () => {
const comics = await picacomic.fetchComics({ category: 'Cosplay' })
console.log(comics)
})()Apache-2.0
