trailpack-proxy-cart/api/models/ShopProduct.js

eCommerce - Trailpack for Proxy Engine

'use strict'

const Model = require('trails/model')
const _ = require('lodash')
const INVENTORY_POLICY = require('../../lib').Enums.INVENTORY_POLICY

/**
 * @module ShopProduct
 * @description Shop Product
 */
module.exports = class ShopProduct extends Model {

  static config (app, Sequelize) {
    return {
      options: {
        underscored: true,
        enums: {
          INVENTORY_POLICY: INVENTORY_POLICY
        }
      }
    }
  }

  static schema (app, Sequelize) {
    return {
      id: {
        type: Sequelize.INTEGER,
        primaryKey: true,
        autoIncrement: true
      },
      product_id: {
        type: Sequelize.INTEGER,
        unique: 'shopproduct_variant'
      },
      variant_id: {
        type: Sequelize.INTEGER,
        unique: 'shopproduct_variant'
      },
      shop_id: {
        type: Sequelize.INTEGER,
        unique: 'shopproduct_variant',
        references: null
      },
      // Specifies whether or not Proxy Cart tracks the number of items in stock for this product variant.
      inventory_management: {
        type: Sequelize.BOOLEAN,
        defaultValue: false
      },
      // Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock.
      inventory_policy: {
        type: Sequelize.ENUM,
        values: _.values(INVENTORY_POLICY),
        defaultValue: INVENTORY_POLICY.DENY
      },
      // Amount of variant in inventory
      inventory_quantity: {
        type: Sequelize.INTEGER,
        defaultValue: 0
      },
      // The average amount of days to come in stock if out of stock
      inventory_lead_time: {
        type: Sequelize.INTEGER,
        defaultValue: 0
      }
    }
  }
}