chore: merge master

server/providers/AudiobookCovers.js

@@ -14,7 +14,7 @@ class AudiobookCovers {
       Logger.error('[AudiobookCovers] Cover search error', error)
       return []
     })
-    return items.map(item => ({ cover: item.filename }))
+    return items.map(item => ({ cover: item.versions.png.original }))
   }
 }
 

server/providers/Audnexus.js

@@ -3,6 +3,14 @@ const { levenshteinDistance } = require('../utils/index')
 const Logger = require('../Logger')
 const Throttle = require('p-throttle')
 
+/**
+ * @typedef AuthorSearchObj
+ * @property {string} asin
+ * @property {string} description
+ * @property {string} image
+ * @property {string} name
+ */
+
 class Audnexus {
   static _instance = null
 
@@ -28,11 +36,19 @@ class Audnexus {
     Audnexus._instance = this
   }
 
+  /**
+   * 
+   * @param {string} name 
+   * @param {string} region 
+   * @returns {Promise<{asin:string, name:string}[]>} 
+   */
   authorASINsRequest(name, region) {
-    name = encodeURIComponent(name)
-    const regionQuery = region ? `&region=${region}` : ''
-    const authorRequestUrl = `${this.baseUrl}/authors?name=${name}${regionQuery}`
+    const searchParams = new URLSearchParams()
+    searchParams.set('name', name)
 
+    if (region) searchParams.set('region', region)
+
+    const authorRequestUrl = `${this.baseUrl}/authors?${searchParams.toString()}`
     Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`)
 
     return this._processRequest(this.limiter(() => axios.get(authorRequestUrl)))
@@ -43,6 +59,12 @@ class Audnexus {
       })
   }
 
+  /**
+   * 
+   * @param {string} asin 
+   * @param {string} region 
+   * @returns {Promise<AuthorSearchObj>}
+   */
   authorRequest(asin, region) {
     asin = encodeURIComponent(asin)
     const regionQuery = region ? `?region=${region}` : ''
@@ -58,6 +80,12 @@ class Audnexus {
       })
   }
 
+  /**
+   * 
+   * @param {string} asin 
+   * @param {string} region 
+   * @returns {Promise<AuthorSearchObj>}
+   */
   async findAuthorByASIN(asin, region) {
     const author = await this.authorRequest(asin, region)
 
@@ -70,24 +98,40 @@ class Audnexus {
       } : null
   }
 
+  /**
+   * 
+   * @param {string} name 
+   * @param {string} region 
+   * @param {number} maxLevenshtein 
+   * @returns {Promise<AuthorSearchObj>}
+   */
   async findAuthorByName(name, region, maxLevenshtein = 3) {
     Logger.debug(`[Audnexus] Looking up author by name ${name}`)
+    const authorAsinObjs = await this.authorASINsRequest(name, region)
 
-    const asins = await this.authorASINsRequest(name, region)
-    const matchingAsin = asins.find(obj => levenshteinDistance(obj.name, name) <= maxLevenshtein)
+    let closestMatch = null
+    authorAsinObjs.forEach((authorAsinObj) => {
+      authorAsinObj.levenshteinDistance = levenshteinDistance(authorAsinObj.name, name)
+      if (!closestMatch || closestMatch.levenshteinDistance > authorAsinObj.levenshteinDistance) {
+        closestMatch = authorAsinObj
+      }
+    })
 
-    if (!matchingAsin) {
+    if (!closestMatch || closestMatch.levenshteinDistance > maxLevenshtein) {
       return null
     }
 
-    const author = await this.authorRequest(matchingAsin.asin)
-    return author ?
-      {
-        description: author.description,
-        image: author.image || null,
-        asin: author.asin,
-        name: author.name
-      } : null
+    const author = await this.authorRequest(closestMatch.asin)
+    if (!author) {
+      return null
+    }
+
+    return {
+      asin: author.asin,
+      description: author.description,
+      image: author.image || null,
+      name: author.name
+    }
   }
 
   getChaptersByASIN(asin, region) {
@@ -124,4 +168,3 @@ class Audnexus {
 }
 
 module.exports = Audnexus
-

server/providers/CustomProviderAdapter.js

@@ -0,0 +1,93 @@
+const Database = require('../Database')
+const axios = require('axios')
+const Logger = require('../Logger')
+
+class CustomProviderAdapter {
+    constructor() { }
+
+    /**
+     * 
+     * @param {string} title 
+     * @param {string} author 
+     * @param {string} providerSlug 
+     * @param {string} mediaType
+     * @returns {Promise<Object[]>}
+     */
+    async search(title, author, providerSlug, mediaType) {
+        const providerId = providerSlug.split('custom-')[1]
+        const provider = await Database.customMetadataProviderModel.findByPk(providerId)
+
+        if (!provider) {
+            throw new Error("Custom provider not found for the given id")
+        }
+
+        // Setup query params
+        const queryObj = {
+            mediaType,
+            query: title
+        }
+        if (author) {
+            queryObj.author = author
+        }
+        const queryString = (new URLSearchParams(queryObj)).toString()
+
+        // Setup headers
+        const axiosOptions = {}
+        if (provider.authHeaderValue) {
+            axiosOptions.headers = {
+                'Authorization': provider.authHeaderValue
+            }
+        }
+
+        const matches = await axios.get(`${provider.url}/search?${queryString}}`, axiosOptions).then((res) => {
+            if (!res?.data || !Array.isArray(res.data.matches)) return null
+            return res.data.matches
+        }).catch(error => {
+            Logger.error('[CustomMetadataProvider] Search error', error)
+            return []
+        })
+
+        if (!matches) {
+            throw new Error("Custom provider returned malformed response")
+        }
+
+        // re-map keys to throw out
+        return matches.map(({
+            title,
+            subtitle,
+            author,
+            narrator,
+            publisher,
+            publishedYear,
+            description,
+            cover,
+            isbn,
+            asin,
+            genres,
+            tags,
+            series,
+            language,
+            duration
+        }) => {
+            return {
+                title,
+                subtitle,
+                author,
+                narrator,
+                publisher,
+                publishedYear,
+                description,
+                cover,
+                isbn,
+                asin,
+                genres,
+                tags: tags?.join(',') || null,
+                series: series?.length ? series : null,
+                language,
+                duration
+            }
+        })
+    }
+}
+
+module.exports = CustomProviderAdapter

server/providers/iTunes.js

@@ -2,16 +2,46 @@ const axios = require('axios')
 const Logger = require('../Logger')
 const htmlSanitizer = require('../utils/htmlSanitizer')
 
+/**
+ * @typedef iTunesSearchParams
+ * @property {string} term
+ * @property {string} country
+ * @property {string} media
+ * @property {string} entity
+ * @property {number} limit
+ */
+
+/**
+ * @typedef iTunesPodcastSearchResult
+ * @property {string} id
+ * @property {string} artistId
+ * @property {string} title
+ * @property {string} artistName
+ * @property {string} description
+ * @property {string} descriptionPlain
+ * @property {string} releaseDate
+ * @property {string[]} genres
+ * @property {string} cover
+ * @property {string} feedUrl
+ * @property {string} pageUrl
+ * @property {boolean} explicit
+ */
+
 class iTunes {
   constructor() { }
 
-  // https://developer.apple.com/library/archive/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html
+  /**
+   * @see https://developer.apple.com/library/archive/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html
+   * 
+   * @param {iTunesSearchParams} options 
+   * @returns {Promise<Object[]>}
+   */
   search(options) {
     if (!options.term) {
       Logger.error('[iTunes] Invalid search options - no term')
       return []
     }
-    var query = {
+    const query = {
       term: options.term,
       media: options.media,
       entity: options.entity,
@@ -82,6 +112,11 @@ class iTunes {
     })
   }
 
+  /**
+   * 
+   * @param {Object} data 
+   * @returns {iTunesPodcastSearchResult}
+   */
   cleanPodcast(data) {
     return {
       id: data.collectionId,
@@ -100,6 +135,12 @@ class iTunes {
     }
   }
 
+  /**
+   * 
+   * @param {string} term 
+   * @param {{country:string}} options 
+   * @returns {Promise<iTunesPodcastSearchResult[]>}
+   */
   searchPodcasts(term, options = {}) {
     return this.search({ term, entity: 'podcast', media: 'podcast', ...options }).then((results) => {
       return results.map(this.cleanPodcast.bind(this))