trailpack-proxy-cart/lib/schemas/proxyCartConfig.js

eCommerce - Trailpack for Proxy Engine

'use strict'
const joi = require('joi')

module.exports =  joi.object().keys({
  // The Nexus of the operation
  nexus: joi.object().keys({
    name: joi.string().required(),
    email: joi.string().required(),
    host: joi.string().required(),
    address: joi.object().keys({
      address_1: joi.string(),
      address_2: [joi.string().allow('').optional(), joi.allow(null)],
      address_3: [joi.string().allow('').optional(), joi.allow(null)],
      company: [joi.string().allow('').optional(), joi.allow(null)],
      city: joi.string(),
      phone: [joi.string().allow('').optional(), joi.allow(null)],
      province: joi.string(),
      province_code: joi.string(),
      country: joi.string(),
      country_code: joi.string(),
      country_name: joi.string(),
      postal_code: joi.string()
    })
  }),
  // Allow
  allow: joi.object().keys({
    destroy_product: joi.boolean(),
    destroy_variant: joi.boolean(),
    // The allowed amounts of these associations and limits
    product_variants: joi.number(),
    product_images: joi.number(),
    product_collections: joi.number(),
    product_associations: joi.number(),
    product_vendors: joi.number(),
    product_shops: joi.number()
  }),
  default_currency: joi.string().valid(['USD']),
  // Countries to load on start
  default_countries: joi.array().items(joi.string()),
  // Orders
  orders: joi.object().keys({
    // On a refund to restock a product
    refund_restock: joi.boolean(),
    // The default type of the payment
    payment_kind: joi.string().valid(['manual', 'immediate']),
    // The default type of transaction
    transaction_kind: joi.string().valid(['authorize', 'sale']),
    // The default type of fulfillment
    fulfillment_kind: joi.string().valid(['manual', 'immediate']),
    // The amount of times a Order will retry failed transactions
    retry_attempts: joi.number(),
    // The amount of days before a Order will cancel from failed transactions
    grace_period_days: joi.number()
  }),
  // Subscriptions
  subscriptions: joi.object().keys({
    // The amount of times a Subscription will retry failed transactions
    retry_attempts: joi.number(),
    // The amount of days before a Subscription will cancel from failed transactions
    grace_period_days: joi.number(),
    // The amount of days before a subscription will renew that notice is given.
    renewal_notice_days: joi.number()
  }),
  // Transactions
  transactions: joi.object().keys({
    // The amount of times a Transaction will retry failed
    retry_attempts: joi.number(),
    // The amount of days before a Transaction's authorization expires
    authorization_exp_days: joi.number()
  }),
  emails: {
    customerRetarget: joi.boolean(),
    customerAccountBalanceDeducted: joi.boolean(),
    customerAccountBalanceCredited: joi.boolean(),
    customerAccountSuspended: joi.boolean(),
    orderCreated: joi.boolean(),
    orderUpdated: joi.boolean(),
    orderPaid: joi.boolean(),
    orderFulfilled: joi.boolean(),
    orderRefunded: joi.boolean(),
    orderCancelled: joi.boolean(),
    sourceExpired: joi.boolean(),
    sourceWillExpire: joi.boolean(),
    sourceUpdated: joi.boolean(),
    subscriptionCreated: joi.boolean(),
    subscriptionUpdated: joi.boolean(),
    subscriptionActivated: joi.boolean(),
    subscriptionDeactivated: joi.boolean(),
    subscriptionCancelled: joi.boolean(),
    subscriptionWillRenew: joi.boolean(),
    subscriptionRenewed: joi.boolean(),
    subscriptionFailed: joi.boolean(),
    transactionFailed: joi.boolean(),
  },
  notifications: {
    admin: joi.object().keys({
      orderCreated: joi.boolean()
    })
  },
  // Events to allow "publish"
  events: joi.object(),  //   .keys({
  //
  // })
  // Pagination Style TODO
  pagination: joi.string().valid(['x-headers','rows']),

  // After Create hooks
  afterCreate: joi.object().keys({
    customer: joi.alternatives().try(
      joi.func(),
      joi.object({
        arg: joi.string(),
        value: joi.func()
      }).unknown()
    ),
    order: joi.alternatives().try(
      joi.func(),
      joi.object({
        arg: joi.string(),
        value: joi.func()
      }).unknown()
    ),
    subscription: joi.alternatives().try(
      joi.func(),
      joi.object({
        arg: joi.string(),
        value: joi.func()
      }).unknown()
    ),
  }),
  // After Update hooks
  afterUpdate: joi.object().keys({
    customer: joi.alternatives().try(
      joi.func(),
      joi.object({
        arg: joi.string(),
        value: joi.func()
      }).unknown()
    ),
    order: joi.alternatives().try(
      joi.func(),
      joi.object({
        arg: joi.string(),
        value: joi.func()
      }).unknown()
    ),
    subscription: joi.alternatives().try(
      joi.func(),
      joi.object({
        arg: joi.string(),
        value: joi.func()
      }).unknown()
    ),
  })
})