Implementing toOld functions for LibraryItem/Book/Podcast

server/models/Book.js

@@ -1,5 +1,7 @@
 const { DataTypes, Model } = require('sequelize')
 const Logger = require('../Logger')
+const { getTitlePrefixAtEnd } = require('../utils')
+const parseNameString = require('../utils/parsers/parseNameString')
 
 /**
  * @typedef EBookFileObject
@@ -113,8 +115,12 @@ class Book extends Model {
     /** @type {Date} */
     this.createdAt
 
+    // Expanded properties
+
     /** @type {import('./Author')[]} - optional if expanded */
     this.authors
+    /** @type {import('./Series')[]} - optional if expanded */
+    this.series
   }
 
   static getOldBook(libraryItemExpanded) {
@@ -241,32 +247,6 @@ class Book extends Model {
     }
   }
 
-  getAbsMetadataJson() {
-    return {
-      tags: this.tags || [],
-      chapters: this.chapters?.map((c) => ({ ...c })) || [],
-      title: this.title,
-      subtitle: this.subtitle,
-      authors: this.authors.map((a) => a.name),
-      narrators: this.narrators,
-      series: this.series.map((se) => {
-        const sequence = se.bookSeries?.sequence || ''
-        if (!sequence) return se.name
-        return `${se.name} #${sequence}`
-      }),
-      genres: this.genres || [],
-      publishedYear: this.publishedYear,
-      publishedDate: this.publishedDate,
-      publisher: this.publisher,
-      description: this.description,
-      isbn: this.isbn,
-      asin: this.asin,
-      language: this.language,
-      explicit: !!this.explicit,
-      abridged: !!this.abridged
-    }
-  }
-
   /**
    * Initialize model
    * @param {import('../Database').sequelize} sequelize
@@ -343,9 +323,50 @@ class Book extends Model {
     }
     return this.authors.map((au) => au.name).join(', ')
   }
+
+  /**
+   * Comma separated array of author names in Last, First format
+   * Requires authors to be loaded
+   *
+   * @returns {string}
+   */
+  get authorNameLF() {
+    if (this.authors === undefined) {
+      Logger.error(`[Book] authorNameLF: Cannot get authorNameLF because authors are not loaded`)
+      return ''
+    }
+
+    // Last, First
+    if (!this.authors.length) return ''
+    return this.authors.map((au) => parseNameString.nameToLastFirst(au.name)).join(', ')
+  }
+
+  /**
+   * Comma separated array of series with sequence
+   * Requires series to be loaded
+   *
+   * @returns {string}
+   */
+  get seriesName() {
+    if (this.series === undefined) {
+      Logger.error(`[Book] seriesName: Cannot get seriesName because series are not loaded`)
+      return ''
+    }
+
+    if (!this.series.length) return ''
+    return this.series
+      .map((se) => {
+        const sequence = se.bookSeries?.sequence || ''
+        if (!sequence) return se.name
+        return `${se.name} #${sequence}`
+      })
+      .join(', ')
+  }
+
   get includedAudioFiles() {
     return this.audioFiles.filter((af) => !af.exclude)
   }
+
   get trackList() {
     let startOffset = 0
     return this.includedAudioFiles.map((af) => {
@@ -355,6 +376,189 @@ class Book extends Model {
       return track
     })
   }
+
+  get hasMediaFiles() {
+    return !!this.hasAudioTracks || !!this.ebookFile
+  }
+
+  get hasAudioTracks() {
+    return !!this.includedAudioFiles.length
+  }
+
+  /**
+   * Total file size of all audio files and ebook file
+   *
+   * @returns {number}
+   */
+  get size() {
+    let total = 0
+    this.audioFiles.forEach((af) => (total += af.metadata.size))
+    if (this.ebookFile) {
+      total += this.ebookFile.metadata.size
+    }
+    return total
+  }
+
+  getAbsMetadataJson() {
+    return {
+      tags: this.tags || [],
+      chapters: this.chapters?.map((c) => ({ ...c })) || [],
+      title: this.title,
+      subtitle: this.subtitle,
+      authors: this.authors.map((a) => a.name),
+      narrators: this.narrators,
+      series: this.series.map((se) => {
+        const sequence = se.bookSeries?.sequence || ''
+        if (!sequence) return se.name
+        return `${se.name} #${sequence}`
+      }),
+      genres: this.genres || [],
+      publishedYear: this.publishedYear,
+      publishedDate: this.publishedDate,
+      publisher: this.publisher,
+      description: this.description,
+      isbn: this.isbn,
+      asin: this.asin,
+      language: this.language,
+      explicit: !!this.explicit,
+      abridged: !!this.abridged
+    }
+  }
+
+  /**
+   * Old model kept metadata in a separate object
+   */
+  oldMetadataToJSON() {
+    const authors = this.authors.map((au) => ({ id: au.id, name: au.name }))
+    const series = this.series.map((se) => ({ id: se.id, name: se.name, sequence: se.bookSeries.sequence }))
+    return {
+      title: this.title,
+      subtitle: this.subtitle,
+      authors,
+      narrators: [...(this.narrators || [])],
+      series,
+      genres: [...(this.genres || [])],
+      publishedYear: this.publishedYear,
+      publishedDate: this.publishedDate,
+      publisher: this.publisher,
+      description: this.description,
+      isbn: this.isbn,
+      asin: this.asin,
+      language: this.language,
+      explicit: this.explicit,
+      abridged: this.abridged
+    }
+  }
+
+  oldMetadataToJSONMinified() {
+    return {
+      title: this.title,
+      titleIgnorePrefix: getTitlePrefixAtEnd(this.title),
+      subtitle: this.subtitle,
+      authorName: this.authorName,
+      authorNameLF: this.authorNameLF,
+      narratorName: (this.narrators || []).join(', '),
+      seriesName: this.seriesName,
+      genres: [...(this.genres || [])],
+      publishedYear: this.publishedYear,
+      publishedDate: this.publishedDate,
+      publisher: this.publisher,
+      description: this.description,
+      isbn: this.isbn,
+      asin: this.asin,
+      language: this.language,
+      explicit: this.explicit,
+      abridged: this.abridged
+    }
+  }
+
+  oldMetadataToJSONExpanded() {
+    const oldMetadataJSON = this.oldMetadataToJSON()
+    oldMetadataJSON.titleIgnorePrefix = getTitlePrefixAtEnd(this.title)
+    oldMetadataJSON.authorName = this.authorName
+    oldMetadataJSON.authorNameLF = this.authorNameLF
+    oldMetadataJSON.narratorName = (this.narrators || []).join(', ')
+    oldMetadataJSON.seriesName = this.seriesName
+    return oldMetadataJSON
+  }
+
+  /**
+   * The old model stored a minified series and authors array with the book object.
+   * Minified series is { id, name, sequence }
+   * Minified author is { id, name }
+   *
+   * @param {string} libraryItemId
+   */
+  toOldJSON(libraryItemId) {
+    if (!libraryItemId) {
+      throw new Error(`[Book] Cannot convert to old JSON because libraryItemId is not provided`)
+    }
+    if (!this.authors) {
+      throw new Error(`[Book] Cannot convert to old JSON because authors are not loaded`)
+    }
+    if (!this.series) {
+      throw new Error(`[Book] Cannot convert to old JSON because series are not loaded`)
+    }
+
+    return {
+      id: this.id,
+      libraryItemId: libraryItemId,
+      metadata: this.oldMetadataToJSON(),
+      coverPath: this.coverPath,
+      tags: [...(this.tags || [])],
+      audioFiles: structuredClone(this.audioFiles),
+      chapters: structuredClone(this.chapters),
+      ebookFile: structuredClone(this.ebookFile)
+    }
+  }
+
+  toOldJSONMinified() {
+    if (!this.authors) {
+      throw new Error(`[Book] Cannot convert to old JSON because authors are not loaded`)
+    }
+    if (!this.series) {
+      throw new Error(`[Book] Cannot convert to old JSON because series are not loaded`)
+    }
+
+    return {
+      id: this.id,
+      metadata: this.oldMetadataToJSONMinified(),
+      coverPath: this.coverPath,
+      tags: [...(this.tags || [])],
+      numTracks: this.trackList.length,
+      numAudioFiles: this.audioFiles?.length || 0,
+      numChapters: this.chapters?.length || 0,
+      duration: this.duration,
+      size: this.size,
+      ebookFormat: this.ebookFile?.ebookFormat
+    }
+  }
+
+  toOldJSONExpanded(libraryItemId) {
+    if (!libraryItemId) {
+      throw new Error(`[Book] Cannot convert to old JSON because libraryItemId is not provided`)
+    }
+    if (!this.authors) {
+      throw new Error(`[Book] Cannot convert to old JSON because authors are not loaded`)
+    }
+    if (!this.series) {
+      throw new Error(`[Book] Cannot convert to old JSON because series are not loaded`)
+    }
+
+    return {
+      id: this.id,
+      libraryItemId: libraryItemId,
+      metadata: this.oldMetadataToJSONExpanded(),
+      coverPath: this.coverPath,
+      tags: [...(this.tags || [])],
+      audioFiles: structuredClone(this.audioFiles),
+      chapters: structuredClone(this.chapters),
+      ebookFile: structuredClone(this.ebookFile),
+      duration: this.duration,
+      size: this.size,
+      tracks: structuredClone(this.trackList)
+    }
+  }
 }
 
 module.exports = Book