adminjs/lib/backend/utils/filter/filter.js

Admin panel for apps written in node.js

import { flat } from '../../../utils/flat/index.js';
export const PARAM_SEPARATOR = '~~';
/**
 * Filter object wrapping up selected filters.
 * @private
 */
export class Filter {
  /**
   * Changes raw nested filters to form Object<path, value>.
   *
   * @example
   * const filters = {
   *  nested: {field: 'ala'},
   *  'dataField~~from': '2019-08-14'
   * }
   *
   * const normalized = Filter.normalizeFilters(filters)
   * // {
   * //   'nested.filter': 'ala',
   * //   'dataField': {from: '2019-08-14'}
   * // }
   *
   *
   * @param   {Object}  filters
   *
   * @return  {Object}
   */
  static normalizeKeys(filters) {
    return flat.unflatten(flat.flatten(filters), {
      delimiter: PARAM_SEPARATOR
    });
  }

  /**
   * @param   {Object<String,Object | String>}  filters   selected filters
   * @param   {BaseResource}                    resource    resource which is filtered
   */
  constructor(filters = {}, resource) {
    this.resource = resource;
    const normalized = Filter.normalizeKeys(filters);
    this.filters = Object.keys(normalized).reduce((memo, path) => {
      memo[path] = {
        path,
        property: this.resource.property(path),
        value: normalized[path]
      };
      return memo;
    }, {});
  }

  /**
   * Returns filter for a given property key
   *
   * @param {String} key      property key
   * @returns {Filter.Property | undefined}
   */
  get(key) {
    return this.filters[key];
  }

  /**
   * Populates all filtered properties which refers to other resources
   */
  async populate(context) {
    const keys = Object.keys(this.filters);
    for (let index = 0; index < keys.length; index += 1) {
      const key = keys[index];
      const referenceResource = this.resource.decorate().getPropertyByKey(key)?.reference();
      if (referenceResource) {
        const value = this.filters[key].value;
        this.filters[key].populated = await referenceResource.findOne(value, context);
      }
    }
    return this;
  }
  reduce(callback, initial) {
    return Object.values(this.filters).reduce(callback, initial || {});
  }
  isVisible() {
    return !!Object.keys(this.filters).length;
  }
}
export default Filter;