index.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/filters/index.ts	100.00%	80%	120	120	0

import { schemaFilter, schemaFormattedFilter } from './schemas.js';

import Ajv from 'ajv';
import { InvalidFiltersError } from '../exceptions/errors.js';
import type { QueryFilter } from 'types.js';
import StateLookup from '../lookups/states/index.js';
import addFormats from 'ajv-formats';

// @ts-expect-error See https://github.com/ajv-validator/ajv/issues/2381
const ajv = new Ajv();
// @ts-expect-error See https://github.com/ajv-validator/ajv/issues/2381
addFormats(ajv);

const DEFAULT_FILTERS: QueryFilter = {
  states: [],
  maxDateTime: null,
  office: null,
  summary: true,
};

/**
 * Class for setting filters for ElectionTonight API.
 */
export class Filters {
  stateLookup: StateLookup;

  constructor() {
    this.stateLookup = new StateLookup();
  }

  private _FILTERS = DEFAULT_FILTERS;

  /**
   * Set or get filter
   */
  filter(filters?: Partial<QueryFilter>) {
    if (!filters) return this.formatFilter(this._FILTERS);

    const validate = ajv.compile(schemaFilter);
    const valid = validate(filters);

    if (!valid) throw new InvalidFiltersError(ajv.errorsText(validate.errors));

    this._FILTERS = { ...DEFAULT_FILTERS, ...filters };
    return this.formatFilter(this._FILTERS);
  }

  resetFilter() {
    this._FILTERS = DEFAULT_FILTERS;
  }

  /**
   * Formats filters that we use when requesting data from endpoints.
   */
  private formatFilter(filters: QueryFilter) {
    const { states, maxDateTime, office, summary } = filters;

    const formatSt = (states: QueryFilter['states']): string => {
      if (!states || states.length === 0) return null;
      return states
        .map((s: string | number) => this.stateLookup.getStateCode(s))
        .filter((d) => d)
        .map((d) => String(d).padStart(2, '0'))
        .join(',');
    };

    type FormattedFilter = {
      st: string | null;
      maxDateTime: string | null;
      ofc: string | null;
      scp: 'S' | 'C';
    };

    const formattedFilter: FormattedFilter = {
      /** Edison API query state filter */
      st: formatSt(states),
      /** Edison API query max datetime filter */
      maxDateTime,
      /** Edison API query office filter */
      ofc: office,
      /** Edison API query scope filter */
      scp: summary ? 'S' : 'C',
    };
    const validate = ajv.compile<FormattedFilter>(schemaFormattedFilter);
    const valid = validate(formattedFilter);
    if (!valid) throw new InvalidFiltersError(ajv.errorsText(validate.errors));
    return formattedFilter as FormattedFilter;
  }
}

[]

TypeScript Coverage Report generated by type-coverage and typescript-coverage-report at Thu, 04 Apr 2024 19:50:44 GMT

TypeScript coverage report