Ghost/ghost/offers/lib/OfferMapper.js
Fabien O'Carroll 504fb1bfa1 Used Value Objects to validate outside of Offer factory
no-issue

This adds the concept of "Value Objects" to an Offers properties,
allowing us to move validation out and ensure that an Offer will only
ever have valid properties, without having to duplicate checks - or
leave them to the persistent layer. This means we can fail early, as
well as write unit tests for all of our validation.
2021-10-07 16:46:08 +02:00

53 lines
1.2 KiB
JavaScript

/**
* @typedef {import('./domain/models/Offer')} Offer
*/
/**
* @typedef {object} OfferDTO
* @prop {string} id
* @prop {string} name
* @prop {string} code
*
* @prop {string} display_title
* @prop {string} display_description
*
* @prop {'percent'|'amount'} type
*
* @prop {'month'|'year'} cadence
* @prop {number} amount
*
* @prop {boolean} currency_restriction
* @prop {string} currency
*
* @prop {object} tier
* @prop {string} tier.id
* @prop {string} tier.name
*/
class OfferMapper {
/**
* @param {Offer} offer
* @returns {OfferDTO}
*/
static toDTO(offer) {
return {
id: offer.id,
name: offer.name.value,
code: offer.code.value,
display_title: offer.displayTitle.value,
display_description: offer.displayDescription.value,
type: offer.type.value,
cadence: offer.cadence.value,
amount: offer.amount.value,
currency_restriction: offer.type === 'amount',
currency: offer.type === 'amount' ? offer.currency : null,
tier: {
id: offer.tier.id,
name: offer.tier.name
}
};
}
}
module.exports = OfferMapper;