esijs/src/market.js

A simple module for ESI.

const { request, inputValidation } = require('./util/util.js')

module.exports = {
    /**
     *
     */
    groups: {
        /**
         * Get information on an item group.

         * @param {number} groupID
         * @returns {Promise<object>}
         */
        groupInfo(groupID) {
            inputValidation({
                input: groupID,
                type: 'number',
                message: `The function 'market.groups.groupInfo' requires a group ID!`,
            })

            return request({
                subUrl: `markets/groups/${groupID}`,
            })
        },

        /**
         * Get a list of item groups.

         * @returns {Promise<[number]>}
         */
        groups() {
            return request({
                subUrl: `markets/groups`,
            })
        },
    },
    /**
     * Return a list of historical market statistics for the specified type in a region.

     * @param {number} regionID
     * @param {number} typeID
     * @returns {Promise<object>}
     */
    history(regionID, typeID) {
        inputValidation({
            input: regionID,
            type: 'number',
            message: `The function 'market.history' requires a region ID!`,
        })
        inputValidation({
            input: typeID,
            type: 'number',
            message: `The function 'market.history' requires a type ID!`,
        })

        return request({
            subUrl: `markets/${regionID}/history`,
            query: {
                type_id: typeID,
            },
        })
    },
    /**
     * Return a list of orders in a region.

     * @param {number} regionID
     * @param {number} typeID
     * @param {string} bOs
     * @param {number} pageNumber
     */
    orders(regionID, typeID, bOs = 'all', pageNumber = 1) {
        bOsOptions = ['all', 'sell', 'buy']
        inputValidation({
            input: regionID,
            type: 'number',
            message: `The function 'market.orders' requires a region ID!`,
        })
        inputValidation({
            input: pageNumber,
            type: 'number',
            message: `The input pageNumber for 'market.orders' requires a number!`,
        })
        inputValidation({
            input: bOs,
            type: 'string',
            options: bOsOptions,
            message: `The function 'market.orders' bOs input must be 'all', 'sell', or 'buy'!`,
        })
        inputValidation({
            input: typeID,
            type: 'number',
            optional: true,
            message: `The function 'market.orders' requires a type ID!`,
        })

        return request({
            subUrl: `markets/${regionID}/orders`,
            query: {
                order_type: bOs,
                page: pageNumber,
                type_id: typeID,
            },
        })
    },
    /**
     * Return a list of prices.

     * @returns {Promise<object>}
     */
    prices() {
        return request({
            subUrl: `markets/prices`,
        })
    },
    /**
     * Return a list of type IDs that have active orders in the region, for efficient market indexing.

     * @param {number} regionID
     * @param {number} pageNumber
     * @returns {Promise<object>}
     */
    types(regionID, pageNumber = 1) {
        inputValidation({
            input: regionID,
            type: 'number',
            message: `The function 'market.types' requires a region ID!`,
        })
        inputValidation({
            input: pageNumber,
            type: 'number',
            message: `The input pageNumber for 'market.types' needs to be a number`,
        })

        return request({
            subUrl: `markets/${regionID}/types`,
        })
    },
}