candidateRace.ts

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

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

/**
 * Returns a description of the candidate status code.
 *
 * @param code A candidate status code.
 * @returns A description of the status code.
 */
const prettifyCandidateStatusCodes = (code: string) => {
  if (code === 'C') return 'Confirmed';
  if (code === 'G') return 'Ghost';
  if (code === 'A') return 'Assumptive';
  return code;
};

/**
 * Parses documents we get from querying the `events/election-race` endpoint. It then transforms the data to fit the structure of the CandidateRace model and returns an array of objects that can be upserted into the model.
 *
 * The returned array contains metadata about candidates in particular races, such as whether they are incumbents or are in the incumbent party.
 */
export const parseCandidateRaces = (documents: Document[]) => {
  const instances: NewCandidateRace[] = [];
  for (const doc of documents) {
    const { officeRace, electionType, state } = parseKey(doc.key);

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

    for (const cand of doc.cand) {
      const {
        cId: candidate,
        incumb,
        listInfo,
        majorPtyId: majorParty,
        numPtyLines: numPartyLines,
        status,
      } = cand;

      const instance: NewCandidateRace = {
        uid: `${officeRace}_${candidate}`,
        candidate,
        majorParty,
        electionType,
        officeRace,
        state,
        specialElection,

        isIncumbent: truthyString(incumb.isIncFlg),
        isInIncumbentParty: truthyString(incumb.inIncPtyFlg),

        estimatesAreReported: truthyString(listInfo.edListFlg),
        candidateOutputOrder: listInfo.outputOrder,
        candidateExitPollOutputOrder: listInfo.xpOrder,

        numPartyLines,
        candidateStatus: prettifyCandidateStatusCodes(status),
      };
      instances.push(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