officeRace.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/events/parsers/election-race/officeRace.ts	100.00%	80%	91	91	0

import type { Document } from './types.js';
import type { NewOfficeRace } from 'db/schema/officeRace.js';
import { parseKey } from 'utils/documentKey.js';
import { isSpecialElection } from 'utils/specialElection.js';
import { truthyString } from 'utils/truthyString.js';

/**
 *  Converts status codes about runoff races to readable, cleaned descriptions. For example, it converts 'N' to 'Never', i.e. there will never be a runoff for this race.
 *
 * @param abbr A runoff status code.
 * @returns A description of the runoff status code.
 */
const prettifyRunoffStatusCodes = (abbr: string) => {
  if (abbr === 'N') return 'Never';
  if (abbr === 'A') return 'Always';
  if (abbr === 'P') return 'Possibly';
  return null;
};

/**
 * Parses documents we get from querying the `events/election-race` endpoint. It then transforms the data to fit the structure of the OfficeRace model and returns an array of objects that can be upserted into the model.
 *
 * The returned array contains metadata about each office race.
 */
export const parseOfficeRaces = (documents: Document[]) => {
  const instances: NewOfficeRace[] = documents.map((doc) => {
    const {
      state,
      jurisdiction,
      jurisdictionRace,
      officeRace: uid,
      office,
      officeBody,
      electionType,
    } = parseKey(doc.key);

    const {
      districtCovFlg,
      estEASCovFlg,
      pctCovFlg,
      runoffCoverage,
      tabCovFlg,
      unfusedCovFlg,
      xpaCovFlg,
    } = doc.covFlags;
    const { dataFinalFlgs } = doc;
    const { totNumCand: totNumCandidates } = doc;

    // Check if it's a special election
    const specialElection = isSpecialElection(electionType, doc.key.ofc);

    const instance: NewOfficeRace = {
      uid,
      electionType,
      jurisdiction,
      jurisdictionRace,
      office,
      officeBody,
      state,
      specialElection,

      candidateListIsFinal: truthyString(dataFinalFlgs.candListFinalFlg),
      exitPollDescriptionsAreFinal: truthyString(dataFinalFlgs.xpDescFinalFlg),
      totNumCandidates,

      // coverage flags
      tabulatedVoteByDistrictIsReported: truthyString(districtCovFlg),
      easEstimatesAreReported: truthyString(estEASCovFlg),
      precinctVoteIsReported: truthyString(pctCovFlg),
      runoffStatus: prettifyRunoffStatusCodes(runoffCoverage),
      tabulatedVoteIsReported: truthyString(tabCovFlg),
      unfusedVoteIsReported: truthyString(unfusedCovFlg),
      exitPollIsReported: truthyString(xpaCovFlg),
    };
    return instance;
  });

  return instances;
};

[]

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

TypeScript coverage report