d2/src/analytics/AnalyticsRequestBase.js

Javascript library for DHIS2

import sortBy from 'lodash/sortBy'

/**
 * @private
 * @description
 * Class for constructing a request object to use for communicating with the analytics API endpoint.
 *
 * @param {!Object} options Object with analytics request options
 *
 * @requires module:lib/utils
 *
 * @memberof module:analytics
 * @abstract
 */
class AnalyticsRequestBase {
    constructor({
        endPoint = 'analytics',
        format = 'json',
        path,
        program,
        dimensions = [],
        filters = [],
        parameters = {},
    } = {}) {
        this.endPoint = endPoint
        this.format = format.toLowerCase()
        this.path = path
        this.program = program

        this.dimensions = dimensions
        this.filters = filters
        this.parameters = { ...parameters }
    }

    /**
     * @private
     * @description
     * Builds the URL to pass to the Api object.
     * The URL includes the dimension(s) parameters.
     * Used internally.
     *
     * @param {Object} options Optional configurations
     *
     * @returns {String} URL URL for the request with dimensions included
     */
    buildUrl(options) {
        // at least 1 dimension is required
        let { dimensions } = this

        if (options && options.sorted) {
            dimensions = sortBy(dimensions, 'dimension')
        }
        const formattedDimensions = dimensions.map(({ dimension, items }) => {
            if (Array.isArray(items) && items.length) {
                if (options && options.sorted) {
                    items = sortBy(items)
                }

                return `${dimension}:${items.join(';')}`
            }

            return dimension
        })

        const endPoint = [this.endPoint, this.path, this.program]
            .filter(e => !!e)
            .join('/')

        return `${endPoint}.${this.format}?dimension=${formattedDimensions.join(
            '&dimension='
        )}`
    }

    /**
     * @private
     * @description
     * Builds the query object passed to the API instance.
     * The object includes all the parameters added via with*() methods
     * and the filters added via addDataFilter(), addPeriodFilter(), addOrgUnitFilter(), addFilter().
     * The filters are handled by the API instance when building the final URL.
     * Used internally.
     *
     * @param {Object} options Optional configurations
     *
     * @returns {Object} Query parameters
     */
    buildQuery(options) {
        let { filters } = this

        if (options && options.sorted) {
            filters = sortBy(filters, 'dimension')
        }

        const formattedFilters = filters.map(({ dimension, items }) => {
            if (Array.isArray(items) && items.length) {
                if (options && options.sorted) {
                    items = sortBy(items)
                }

                return `${dimension}:${items.join(';')}`
            }

            return dimension
        })

        if (filters.length) {
            this.parameters.filter = formattedFilters
        }

        return this.parameters
    }
}

export default AnalyticsRequestBase