Add jsdoc types for models

server/models/BookSeries.js

@@ -1,42 +1,61 @@
 const { DataTypes, Model } = require('sequelize')
 
-module.exports = (sequelize) => {
-  class BookSeries extends Model {
-    static removeByIds(seriesId = null, bookId = null) {
-      const where = {}
-      if (seriesId) where.seriesId = seriesId
-      if (bookId) where.bookId = bookId
-      return this.destroy({
-        where
-      })
-    }
+class BookSeries extends Model {
+  constructor(values, options) {
+    super(values, options)
+
+    /** @type {UUIDV4} */
+    this.id
+    /** @type {string} */
+    this.sequence
+    /** @type {UUIDV4} */
+    this.bookId
+    /** @type {UUIDV4} */
+    this.seriesId
+    /** @type {Date} */
+    this.createdAt
   }
 
-  BookSeries.init({
-    id: {
-      type: DataTypes.UUID,
-      defaultValue: DataTypes.UUIDV4,
-      primaryKey: true
-    },
-    sequence: DataTypes.STRING
-  }, {
-    sequelize,
-    modelName: 'bookSeries',
-    timestamps: true,
-    updatedAt: false
-  })
+  static removeByIds(seriesId = null, bookId = null) {
+    const where = {}
+    if (seriesId) where.seriesId = seriesId
+    if (bookId) where.bookId = bookId
+    return this.destroy({
+      where
+    })
+  }
 
-  // Super Many-to-Many
-  // ref: https://sequelize.org/docs/v6/advanced-association-concepts/advanced-many-to-many/#the-best-of-both-worlds-the-super-many-to-many-relationship
-  const { book, series } = sequelize.models
-  book.belongsToMany(series, { through: BookSeries })
-  series.belongsToMany(book, { through: BookSeries })
+  /**
+   * Initialize model
+   * @param {import('../Database').sequelize} sequelize 
+   */
+  static init(sequelize) {
+    super.init({
+      id: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true
+      },
+      sequence: DataTypes.STRING
+    }, {
+      sequelize,
+      modelName: 'bookSeries',
+      timestamps: true,
+      updatedAt: false
+    })
 
-  book.hasMany(BookSeries)
-  BookSeries.belongsTo(book)
+    // Super Many-to-Many
+    // ref: https://sequelize.org/docs/v6/advanced-association-concepts/advanced-many-to-many/#the-best-of-both-worlds-the-super-many-to-many-relationship
+    const { book, series } = sequelize.models
+    book.belongsToMany(series, { through: BookSeries })
+    series.belongsToMany(book, { through: BookSeries })
 
-  series.hasMany(BookSeries)
-  BookSeries.belongsTo(series)
+    book.hasMany(BookSeries)
+    BookSeries.belongsTo(book)
 
-  return BookSeries
-}
+    series.hasMany(BookSeries)
+    BookSeries.belongsTo(series)
+  }
+}
+
+module.exports = BookSeries