mirror/advplyr.audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2025-06-23 01:09:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update API JS docs

Browse source
This commit is contained in:
advplyr 2024-08-11 17:01:25 -05:00
parent 2472b86284
commit e53ac6566b
24 changed files with 390 additions and 175 deletions
Download patch file Download diff file Expand all files Collapse all files

51
server/controllers/AuthorController.js
View file

@ -1,3 +1,4 @@
const { Request, Response, NextFunction } = require('express')
const sequelize = require('sequelize')
const fs = require('../libs/fsExtra')
const { createNewSortInstance } = require('../libs/fastSort')
@ -14,9 +15,23 @@ const { reqSupportsWebp, isValidASIN } = require('../utils/index')
const naturalSort = createNewSortInstance({
comparer: new Intl.Collator(undefined, { numeric: true, sensitivity: 'base' }).compare
})
/**
* @typedef RequestUserObject
* @property {import('../models/User')} user
*
* @typedef {Request & RequestUserObject} RequestWithUser
*/
class AuthorController {
constructor() {}
/**
* GET: /api/authors/:id
*
* @param {RequestWithUser} req
* @param {Response} res
*/
async findOne(req, res) {
const include = (req.query.include || '').split(',')
@ -63,9 +78,10 @@ class AuthorController {
}
/**
* PATCH: /api/authors/:id
*
* @param {import('express').Request} req
* @param {import('express').Response} res
* @param {RequestWithUser} req
* @param {Response} res
*/
async update(req, res) {
const payload = req.body
@ -194,8 +210,8 @@ class AuthorController {
* DELETE: /api/authors/:id
* Remove author from all books and delete
*
* @param {import('express').Request} req
* @param {import('express').Response} res
* @param {RequestWithUser} req
* @param {Response} res
*/
async delete(req, res) {
Logger.info(`[AuthorController] Removing author "${req.author.name}"`)
@ -218,8 +234,8 @@ class AuthorController {
* POST: /api/authors/:id/image
* Upload author image from web URL
*
* @param {import('express').Request} req
* @param {import('express').Response} res
* @param {RequestWithUser} req
* @param {Response} res
*/
async uploadImage(req, res) {
if (!req.user.canUpload) {
@ -263,8 +279,8 @@ class AuthorController {
* DELETE: /api/authors/:id/image
* Remove author image & delete image file
*
* @param {import('express').Request} req
* @param {import('express').Response} res
* @param {RequestWithUser} req
* @param {Response} res
*/
async deleteImage(req, res) {
if (!req.author.imagePath) {
@ -284,6 +300,12 @@ class AuthorController {
})
}
/**
* POST: /api/authors/:id/match
*
* @param {RequestWithUser} req
* @param {Response} res
*/
async match(req, res) {
let authorData = null
const region = req.body.region || 'us'
@ -334,7 +356,12 @@ class AuthorController {
})
}
// GET api/authors/:id/image
/**
* GET: /api/authors/:id/image
*
* @param {RequestWithUser} req
* @param {Response} res
*/
async getImage(req, res) {
const {
query: { width, height, format, raw },
@ -358,6 +385,12 @@ class AuthorController {
return CacheManager.handleAuthorCache(res, author, options)
}
/**
*
* @param {RequestWithUser} req
* @param {Response} res
* @param {NextFunction} next
*/
async middleware(req, res, next) {
const author = await Database.authorModel.getOldById(req.params.id)
if (!author) return res.sendStatus(404)