atix-internetmarke/lib/Order/Order.js

A node wrapper for the Internetmarke web service of the Deutsche Post.

/**
 * internetmarke
 * Copyright (c) 2018 Manuel Schächinger
 * MIT Licensed
 */

'use strict';

const Position = require('./Position'),
  errors = require('../errors');

class Order {
  /**
   * An order defines a set of positions / vouchers that can be checked out in
   * one step with a single order id.
   * 
   * @param {Object} data
   * @param {(number|string)} [data.orderId] - The order id that is linked to
   *   the position if known.
   */
  constructor({ orderId = null } = {}) {
    /** @type {(number|string)} */
    this._orderId = orderId;
    /** @type {Position[]} */
    this._positions = [];
  }

  /**
   * Add a position to the order.
   * 
   * @param {Object} position
   * @param {Product} position.product - The product that should be ordered.
   * @param {number} position.productCode - The product code that identifies
   *   the selected product if the product was not given.
   * @param {string} position.voucherLayout - The layout the voucher should be
   *   generated in.
   * @param {number} position.price - The price of the given product. This is
   *   only necessary when the productCode is given instead of the product.
   * @param {AddressBinding} [position.addressBinding] - The pair of addresses
   *   if available. This is only possible for AddressZone layout.
   */
  addPosition({ product, productCode, voucherLayout, price, addressBinding = null }) {
    if (product) {
      productCode = product.getId();
      price = product.getPrice();
    }

    this._positions.push(
      new Position({ productCode, voucherLayout, price, addressBinding })
    );
    
    // TODO: generate a unique id to make the position removable
  }

  /**
   * Checkout the complete order and convert the data into the api format.
   * Checkout requires an order id.
   * 
   * @param {Object} metadata
   * @param {number} [metadata.orderId] - The order id if not defined, yet.
   * @param {boolean} [metadata.createManifest] - Determine whether a manifest
   *   should be generated and attached after checkout.
   * @param {number} [metadata.createShippingList] - Determine whether a shipping
   *   list should be created: 0: no, 1: without addresses, 2: with addresses
   * @returns {Object}
   */
  getCheckout({ orderId = this.orderId, createManifest = true, createShippingList = 2 } = {}) {
    if (!this._positions.length) {
      throw new Error(errors.internetmarke.shoppingcartEmpty);
    }

    const positions = [];
    let total = 0;

    this._positions.forEach(pos => {
      total += pos.getPrice();
      positions.push(pos.getPosition());
    });

    const order = {
      positions,
      total,
      createManifest,
      createShippingList
    };

    if (orderId) {
      order.shopOrderId = orderId;
    }

    return order;
  }
}

module.exports = Order;