InvenioRecordsResourcesRequestSerializer.js

/*
 * SPDX-FileCopyrightText: 2021 CERN.
 * SPDX-License-Identifier: MIT
 */

import Qs from "qs";
import _extend from "lodash/extend";
import _isEmpty from "lodash/isEmpty";

/** Default backend request serializer for invenio-records-resources */
export class InvenioRecordsResourcesRequestSerializer {
  constructor() {
    this.serialize = this.serialize.bind(this);
  }

  _checkFilter = (filter) => {
    if (!Array.isArray(filter)) {
      throw new Error(`Filter value "${filter}" in query state must be an array.`);
    }
    if (!(filter.length === 2 || filter.length === 3)) {
      throw new Error(
        `Filter value "${filter}" in query state must be an array of 2 or 3 elements`
      );
    }
  };

  _addFilter = (filter, filterUrlParams) => {
    this._checkFilter(filter);
    const aggName = filter[0];
    const fieldValue = filter[1];
    const hasChild = filter.length === 3;
    if (hasChild) {
      this._checkFilter(filter[2]);
    }
    if (aggName in filterUrlParams) {
      if (hasChild) {
        filterUrlParams[aggName].push(fieldValue + "::" + filter[2][1]);
      } else {
        filterUrlParams[aggName].push(fieldValue);
      }
    } else {
      if (hasChild) {
        filterUrlParams[aggName] = [fieldValue + "::" + filter[2][1]];
      } else {
        filterUrlParams[aggName] = [fieldValue];
      }
    }
  };

  _addFilters = (filters) => {
    if (!Array.isArray(filters)) {
      throw new Error(`Filters query state "${filters}" must be an array.`);
    }
    /**
     * input: [
     *   [ 'type_agg', 'value1' ]
     *   [ 'type_agg', 'value2', [ 'subtype_agg', 'a value' ] ]
     * ]
     */
    const filterUrlParams = {};
    filters.forEach((filter) => {
      this._addFilter(filter, filterUrlParams);
    });
    /**
     * output: {
     *  type_agg: ['value1', 'value2::a value']
     * }
     */

    return filterUrlParams;
  };

  /**
   * Return a serialized version of the app state `query` for the API backend.
   * @param {object} stateQuery the `query` state to serialize
   */
  serialize(stateQuery) {
    const { queryString, sortBy, sortOrder, page, size, filters, hiddenParams } =
      stateQuery;

    let getParams = {};
    if (queryString !== null) {
      getParams["q"] = queryString;
    }
    if (sortBy !== null) {
      getParams["sort"] = sortBy;

      if (sortOrder !== null) {
        getParams["sort"] = sortOrder === "desc" ? `-${sortBy}` : sortBy;
      }
    }
    if (page > 0) {
      getParams["page"] = page;
    }
    if (size > 0) {
      getParams["size"] = size;
    }
    if (!_isEmpty(hiddenParams)) {
      _extend(getParams, this._addFilters(hiddenParams));
    }
    const filterParams = this._addFilters(filters);
    _extend(getParams, filterParams);

    return Qs.stringify(getParams, { arrayFormat: "repeat" });
  }
}