pastCandidateVote.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/events/parsers/past-county-data/pastCandidateVote.ts	100.00%	80%	88	88	0

import {
  parseKey,
  parseOfficeRaceUid,
  parseOfficeUid,
} from 'utils/documentKey.js';

import type { Document } from './types.js';
import type { NewPastCandidateVote } from 'db/schema/pastCandidateVote.js';
import { truthyString } from 'utils/truthyString.js';
import { validateTimestamp } from 'utils/validateTimestamp.js';

/**
 * Parses documents we get from querying the `events/past-county-data` endpoint. It then transforms the data to fit the structure of the PastCandidateVote model and returns an array of objects that can be upserted into the model.
 *
 * The returned array contains vote counts for each candidate in each county for a particular election in the past. Each candidate may have voting data for multiple past elections.
 */
export const parsePastCandidateVotes = (documents: Document[]) => {
  const instances: NewPastCandidateVote[] = [];
  for (const doc of documents) {
    const { state, jurisdiction, jurisdictionRace, electionType } = parseKey(
      doc.key
    );
    const { eDate: pastElectionDate } = doc.key;
    const { races } = doc;

    for (const racePartial of races) {
      const race = racePartial as typeof racePartial & {
        cands?: typeof racePartial.cand;
      };
      /**
       * 🚨 Inconsistent with ElectionTonight API docs
       * ElectionTonight API docs say the candidates array is called `cand` but it's sometimes
       * called `cands` instead in the actual document returned from endpoint queries.
       */
      const { ofc, cand: candidates, cands: deprecatedCandidates } = race;

      // Get unique IDs
      const office = parseOfficeUid(jurisdiction, ofc);
      const officeRace = parseOfficeRaceUid(office, electionType);

      // Loop through candidates
      for (const c of candidates || deprecatedCandidates) {
        const {
          cId: candidate,
          cVote: totalCandidateVotes,
          edListFlg,
          isResearchFlg,
        } = c;

        // Get unique ID
        const candidateRace = `${officeRace}_${candidate}`;

        const instance: NewPastCandidateVote = {
          uid: `${candidateRace}_${pastElectionDate}`,

          candidate,
          state,

          // Non-foreign keys
          // We can't associate PastCandidateVote to these models because candidates may have run for
          // offices different from what they're currently running for in past elections.
          /**
           * @TODO This means we need many-to-many models. -Jon
           */
          candidateRace,
          jurisdiction,
          jurisdictionRace,
          office,
          officeRace,

          // Candidate's total vote count
          totalCandidateVotes,

          // Flags
          candidateIsInEditorialList: truthyString(edListFlg),
          pastCandidateUsedInComputations: truthyString(isResearchFlg),

          // Past electiond ate
          pastElectionDate: validateTimestamp(pastElectionDate),
        };
        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