index.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/results/parsers/delegate-vote/index.ts	100.00%	80%	522	522	0

import { parseCountyCode, parseKey } from 'utils/documentKey.js';
import {
  prettifyProgressTypeCodes,
  prettifyReportingSourceTypeCodes,
  prettifyTransmissionSourceTypeCodes,
} from 'utils/prettifyCodes.js';

import type { Document } from './types.js';
import type { NewPresidentialPrimaryDistrictVoteByCounty } from 'db/schema/presidentialPrimaryDistrictVoteByCounty.js';
import type { NewPresidentialPrimaryVoteByDistrict } from 'db/schema/presidentialPrimaryVoteByDistrict.js';
import { truthyString } from 'utils/truthyString.js';
import { validateTimestamp } from 'utils/validateTimestamp.js';

/**
 * Parses documents we get from querying the `results/delegate-vote` endpoint. It then transforms the data to fit the structure of the PresidentialPrimaryDistrictVoteByCounty model and returns an array of objects that can be upserted into the model.
 *
 * Note that the `results/delegate-vote` endpoint contains votes data at both the congressional district and county level. In this parser, we are only parsing the county data.
 */
const parsePresidentialPrimaryDistrictVotesByCounty = (
  documents: Document[]
) => {
  const instances: NewPresidentialPrimaryDistrictVoteByCounty[] = [];

  for (const doc of documents) {
    const {
      absOut: absenteeVoteOutstanding, // from ElectionTonight API documentation on results/county-vote
      candidates,
      dist, // optional
      maxAbs: maxAbsenteeBallotsExpected, // from ElectionTonight API documentation on results/county-vote
      pcnt: precinctId, // from ElectionTonight API documentation on results/county-vote
      pctsRep: totalPrecinctsReportingSoFar, // from ElectionTonight API documentation on results/county-vote
      proOut: provisionalVoteOutstanding,
      scp,
      seq: sequence,

      // votes. Descriptions from ElectionTonight API documentation on results/county-vote
      totalblts: totalBallots,
      /**
       * @TODO totAvote NOT on schema. Is this outdated?
       */
      // @ts-ignore
      totAvote: totalAbsenteeVote,
      totEarlyByMailVote: totalEarlyByMailVote,
      totEarlyInPersonVote: totalEarlyInPersonVote,
      totEdayVote: totalElectionDayVote,
      totPcts: totalPrecincts,
      totProvisionalVote: totalProvisionalVote,
      totVote: totalVote,

      transSrc,
      ts,
    } = doc;

    // Parsed UIDs from doc.key
    const { electionType, state } = parseKey(doc.key);

    // Other fields we need from doc.key
    /**
     * @TODO dId and dType are NOT on schema. Is this outdated?
     */
    // @ts-ignore
    const { cnty, dId, dType, eDate, eType, ofc: officeCode, st } = doc.key;

    // Get delegate district UID
    const delegateDistrict = `${st}_${eType}_${dType}_${dId}`;

    // Get county UID
    const county = parseCountyCode(state, cnty);

    // In this parser, we are only parsing the county-level data.
    // So skip if county is null.
    if (!county) continue;

    // Flags
    const {
      absVotes: absenteeVoteProgress,
      canceled,
      complete,
      final,
      proVotes: voteTabulationProgress,
      repSrc: reportingSource,
      verified,
    } = doc.flgs;

    for (const c of candidates) {
      const {
        cId: candidate,
        cVote: candidateVote,
        aVote: absenteeVote,
        earlyByMailVote,
        earlyInPersonVote,
        /**
         * @TODO eDayVote NOT on schema. Is this outdated?
         */
        // @ts-ignore
        eDayVote: electionDayVote,
        provisionalVote,
      } = c;

      // Get the UID for this model
      /** @NOTE - ElectionTonight API client says district data is optional, but this is included in the key and seems to be necessary for creating UIDs */
      const uid = `${delegateDistrict}_${candidate}_${county}`;

      // Optional party-line votes for a single candidate/party combination. There is one instance per un-fused party-line vote count in the contest.
      if (c.party) {
        for (const p of c.party) {
          const {
            pId: party,

            /**
             * Represents the votes for the candidate under that party line.
             *
             * In states where fusion is an issue, will transmit both fused and unfused votes.
             */
            unfusedCVote: unfusedCandidateVote,
          } = p;
          const instance: NewPresidentialPrimaryDistrictVoteByCounty = {
            uid: `${uid}_${party}`,
            candidate,
            county,
            delegateDistrict,
            electionType, // D or R for Dem/Rep primaries
            party, // 🚨 May not be provided by Edison, so allow null
            state,

            // Candidate votes data
            candidateVote,

            // Votes allong party lines
            unfusedCandidateVote,

            // Precincts info
            precinctId,
            totalPrecincts,
            totalPrecinctsReportingSoFar,

            // Other optional vote data
            absenteeVoteOutstanding,
            maxAbsenteeBallotsExpected,
            provisionalVoteOutstanding,

            absenteeVote,
            earlyByMailVote,
            earlyInPersonVote,
            electionDayVote,
            provisionalVote,

            totalBallots,
            totalAbsenteeVote,
            totalEarlyByMailVote,
            totalEarlyInPersonVote,
            totalElectionDayVote,
            totalProvisionalVote,
            totalVote,

            // Optional district info
            districtId: dist?.dId,
            districtTypeCode: dist?.dType,

            // Flags
            absenteeVoteProgress:
              prettifyProgressTypeCodes(absenteeVoteProgress),
            canceled: truthyString(canceled),
            complete: truthyString(complete),
            final: truthyString(final),
            voteTabulationProgress: prettifyProgressTypeCodes(
              voteTabulationProgress
            ),
            reportingSource: prettifyReportingSourceTypeCodes(reportingSource),
            verified: truthyString(verified),

            // Other metadata
            electionDate: validateTimestamp(eDate),
            officeCode,
            scope: scp,
            sequence,
            timestamp: validateTimestamp(ts),
            transmissionSource: prettifyTransmissionSourceTypeCodes(transSrc),
          };

          instances.push(instance);
        }
      }

      // If c.party is not provided, add data without the party information.
      else {
        const instance: NewPresidentialPrimaryDistrictVoteByCounty = {
          uid,
          candidate,
          county,
          delegateDistrict,
          electionType, // D or R for Dem/Rep primaries
          state,

          // Candidate vote data
          candidateVote,

          // Precincts info
          precinctId,
          totalPrecinctsReportingSoFar,

          // Other optional vote data
          absenteeVoteOutstanding,
          maxAbsenteeBallotsExpected,
          provisionalVoteOutstanding,

          absenteeVote,
          earlyByMailVote,
          earlyInPersonVote,
          electionDayVote,
          provisionalVote,

          totalBallots,
          totalAbsenteeVote,
          totalEarlyByMailVote,
          totalEarlyInPersonVote,
          totalElectionDayVote,
          totalPrecincts,
          totalProvisionalVote,
          totalVote,

          // Optional district info
          districtId: dist?.dId,
          districtTypeCode: dist?.dType,

          // Flags
          absenteeVoteProgress: prettifyProgressTypeCodes(absenteeVoteProgress),
          canceled: truthyString(canceled),
          complete: truthyString(complete),
          final: truthyString(final),
          voteTabulationProgress: prettifyProgressTypeCodes(
            voteTabulationProgress
          ),
          reportingSource: prettifyReportingSourceTypeCodes(reportingSource),
          verified: truthyString(verified),

          // Other metadata
          electionDate: validateTimestamp(eDate),
          officeCode,
          scope: scp,
          sequence,
          timestamp: validateTimestamp(ts),
          transmissionSource: prettifyTransmissionSourceTypeCodes(transSrc),
        };
        instances.push(instance);
      }
    }
  }
  return instances;
};

const parseSequenceId = (doc: Document) => {
  const { electionType, county } = parseKey(doc.key);
  return `${county || 0}_${electionType}`;
};

/**
 * Parses documents we get from querying the `results/delegate-vote` endpoint. It then transforms the data to fit the structure of the PresidentialPrimaryVote model and returns an array of objects that can be upserted into the model.
 *
 * Note that the `results/delegate-vote` endpoint contains votes data at both the congressional district and county level. In this parser, we are only parsing the district-level data.
 */
const parsePresidentialPrimaryVotesByDistrict = (documents: Document[]) => {
  const instances: NewPresidentialPrimaryVoteByDistrict[] = [];

  for (const doc of documents) {
    const {
      absOut: absenteeVoteOutstanding, // from ElectionTonight API documentation on results/county-vote
      candidates,
      dist, // optional
      maxAbs: maxAbsenteeBallotsExpected, // from ElectionTonight API documentation on results/county-vote
      pcnt: precinctId, // from ElectionTonight API documentation on results/county-vote
      pctsRep: totalPrecinctsReportingSoFar, // from ElectionTonight API documentation on results/county-vote
      proOut: provisionalVoteOutstanding,
      scp,
      seq: sequence,

      // votes. Descriptions from ElectionTonight API documentation on results/county-vote
      totalblts: totalBallots,
      /**
       * @TODO totAvote NOT on schema. Is this outdated?
       */
      // @ts-ignore
      totAvote: totalAbsenteeVote,
      totEarlyByMailVote: totalEarlyByMailVote,
      totEarlyInPersonVote: totalEarlyInPersonVote,
      totEdayVote: totalElectionDayVote,
      totPcts: totalPrecincts,
      totProvisionalVote: totalProvisionalVote,
      totVote: totalVote,

      transSrc,
      ts,
    } = doc;

    // Parsed UIDs from doc.key
    const { electionType, state } = parseKey(doc.key);

    // Other fields we need from doc.key
    /**
     * @TODO dId and dType are NOT on schema. Is this outdated?
     */
    // @ts-ignore
    const { cnty, dId, dType, eDate, eType, ofc: officeCode, st } = doc.key;

    // Get the delegate district UID
    const delegateDistrict = `${st}_${eType}_${dType}_${dId}`;

    // Get the county UID
    const county = parseCountyCode(state, cnty);

    // In this parser, we are only parsing the district-level data.
    // So skip if county exists and is not null
    if (county) continue;

    // Flags
    const {
      absVotes: absenteeVoteProgress,
      canceled,
      complete,
      final,
      proVotes: voteTabulationProgress,
      repSrc: reportingSource,
      verified,
    } = doc.flgs;

    for (const c of candidates) {
      const {
        cId: candidate,
        cVote: candidateVote,
        aVote: absenteeVote,
        earlyByMailVote,
        earlyInPersonVote,
        /**
         * @TODO eDayVote NOT on schema. Is this outdated?
         */
        // @ts-ignore
        eDayVote: electionDayVote,
        provisionalVote,
      } = c;

      // Get the UID for this model
      const uid = `${delegateDistrict}_${candidate}`;

      // Optional party-line votes for a single candidate/party combination. There is one instance per un-fused party-line vote count in the contest.
      if (c.party) {
        for (const p of c.party) {
          const {
            pId: party,

            /**
             * Represents the votes for the candidate under that party line.
             *
             * In states where fusion is an issue, will transmit both fused and unfused votes.
             */
            unfusedCVote: unfusedCandidateVote,
          } = p;

          const instance: NewPresidentialPrimaryVoteByDistrict = {
            uid: `${uid}_${party}`,
            candidate,
            delegateDistrict,
            electionType, // D or R for Dem/Rep primaries
            party, // 🚨 May not be provided by Edison, so allow null
            state,

            // Candidate votes data
            candidateVote,

            // Votes allong party lines
            unfusedCandidateVote,

            // Precincts info
            precinctId,
            totalPrecincts,
            totalPrecinctsReportingSoFar,

            // Other optional vote data
            absenteeVoteOutstanding,
            maxAbsenteeBallotsExpected,
            provisionalVoteOutstanding,

            absenteeVote,
            earlyByMailVote,
            earlyInPersonVote,
            electionDayVote,
            provisionalVote,

            totalBallots,
            totalAbsenteeVote,
            totalEarlyByMailVote,
            totalEarlyInPersonVote,
            totalElectionDayVote,
            totalProvisionalVote,
            totalVote,

            // Optional district info
            districtId: dist?.dId,
            districtTypeCode: dist?.dType,

            // Flags
            absenteeVoteProgress:
              prettifyProgressTypeCodes(absenteeVoteProgress),
            canceled: truthyString(canceled),
            complete: truthyString(complete),
            final: truthyString(final),
            voteTabulationProgress: prettifyProgressTypeCodes(
              voteTabulationProgress
            ),
            reportingSource: prettifyReportingSourceTypeCodes(reportingSource),
            verified: truthyString(verified),

            // Other metadata
            electionDate: validateTimestamp(eDate),
            officeCode,
            scope: scp,
            sequence,
            timestamp: validateTimestamp(ts),
            transmissionSource: prettifyTransmissionSourceTypeCodes(transSrc),
          };

          instances.push(instance);
        }
      }

      // If c.party is not provided, add data without the party information.
      else {
        const instance: NewPresidentialPrimaryVoteByDistrict = {
          /** ElectionTonight API client says district data is optional, but this is included in the key and seems to be necessary for creating UIDs */
          uid,
          candidate,
          delegateDistrict,
          electionType, // D or R for Dem/Rep primaries
          state,

          // Candidate vote data
          candidateVote,

          // Precincts info
          precinctId,
          totalPrecinctsReportingSoFar,

          // Other optional vote data
          absenteeVoteOutstanding,
          maxAbsenteeBallotsExpected,
          provisionalVoteOutstanding,

          absenteeVote,
          earlyByMailVote,
          earlyInPersonVote,
          electionDayVote,
          provisionalVote,

          totalBallots,
          totalAbsenteeVote,
          totalEarlyByMailVote,
          totalEarlyInPersonVote,
          totalElectionDayVote,
          totalPrecincts,
          totalProvisionalVote,
          totalVote,

          // Optional district info
          districtId: dist?.dId,
          districtTypeCode: dist?.dType,

          // Flags
          absenteeVoteProgress: prettifyProgressTypeCodes(absenteeVoteProgress),
          canceled: truthyString(canceled),
          complete: truthyString(complete),
          final: truthyString(final),
          voteTabulationProgress: prettifyProgressTypeCodes(
            voteTabulationProgress
          ),
          reportingSource: prettifyReportingSourceTypeCodes(reportingSource),
          verified: truthyString(verified),

          // Other metadata
          electionDate: validateTimestamp(eDate),
          officeCode,
          scope: scp,
          sequence,
          timestamp: validateTimestamp(ts),
          transmissionSource: prettifyTransmissionSourceTypeCodes(transSrc),
        };
        instances.push(instance);
      }
    }
  }
  return instances;
};

export default {
  parsePresidentialPrimaryVotesByDistrict,
  parsePresidentialPrimaryDistrictVotesByCounty,
  parseSequenceId,
};

[]

TypeScript coverage report