index.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/results/parsers/total-expected-vote/index.ts	100.00%	80%	154	154	0

import {
  prettifyProgressTypeCodes,
  prettifyReportingSourceTypeCodes,
} from 'utils/prettifyCodes.js';

import type { Document } from './types.js';
import type { NewDocumentSequence } from 'db/schema/documentSequence.js';
import type { NewTotalExpectedVote } from 'db/schema/totalExpectedVote.js';
import { TOTAL_EXPECTED_VOTE } from 'constants/docTypes.js';
import { parseKey } from 'utils/documentKey.js';
import { truthyString } from 'utils/truthyString.js';
import { validateTimestamp } from 'utils/validateTimestamp.js';

/**
 * Parses documents we get from querying the `results/total-expected-vote` endpoint. It then transforms the data to fit the structure of the TotalExpectedVote model and returns an array of objects that can be upserted into the model.
 */
const parseTotalExpectedVotes = (documents: Document[]) => {
  const instances: NewTotalExpectedVote[] = [];
  for (const doc of documents) {
    const {
      absVotes: absenteeVoteProgress,
      canceled: cancelled,
      cnty,
      complete,
      countyOutstandingBallot,
      eType,
      final,
      jCde,
      jType,
      outstandingVoteType,
      pcntRepType: precinctReportType,
      proVotes: voteTabulationProgress,
      repSrc: reportingSource,
      st,
      totExpAVoteEst: totalExpectedAbsenteeVote,
      totExpEarlyByMailVoteEst: totalExpectedEarlyByMailVote,
      totExpEarlyInPersonVoteEst: totalExpectedEarlyInPersonVote,
      totExpEdayVoteEst: totalExpectedElectionDayVote,
      totExpVoteEst: totalExpectedVote,
      totalExpectedVoteMode,
      ts,
      turnoutStage,
      verified,
    } = doc;

    /**
     * @TODO
     * 🚨 Inconsistent with API docs
     * doc.key: Exists in older docs, i.e. 20201103
     * no do.key: Current API doc says values such as jcde, eType, etc. are in the document itself
     */
    const defaultKey = { st, cnty, eType, jCde, jType };
    const key = (doc['key'] as typeof defaultKey) || defaultKey;
    const { state, county, jurisdiction, jurisdictionRace } = parseKey(key);

    const instance: NewTotalExpectedVote = {
      uid: `${jurisdictionRace}_${county || 0}`,
      state,
      county,
      jurisdiction,
      jurisdictionRace,
      electionType: eType,
      turnoutStage,

      countyOutstandingBallot,
      outstandingVoteType:
        outstandingVoteType && outstandingVoteType.length > 0
          ? outstandingVoteType.join(', ')
          : null,
      voteTabulationProgress: prettifyProgressTypeCodes(voteTabulationProgress),
      precinctReportType,
      reportingSource: prettifyReportingSourceTypeCodes(reportingSource),
      absenteeVoteProgress: prettifyProgressTypeCodes(absenteeVoteProgress),

      totalExpectedAbsenteeVote,
      totalExpectedEarlyByMailVote,
      totalExpectedEarlyInPersonVote,
      totalExpectedElectionDayVote,
      totalExpectedVote,
      totalExpectedVoteMode,

      final: truthyString(final),
      complete: truthyString(complete),
      verified: truthyString(verified),
      cancelled: truthyString(cancelled),
      timestamp: validateTimestamp(ts),
    };
    instances.push(instance);
  }
  return instances;
};

const parseSequenceId = (doc: Document) => {
  /**
   * Note total-expected-vote docs don't have a key property.
   * Instead we have parse the document itself, which has properties
   * we use to create a pseudo-document UID.
   */
  const { jurisdictionRace, county } = parseKey(doc);
  return `${jurisdictionRace}_${county || 0}`;
};

const parseDocumentSequences = (documents: Document[]) => {
  const sequences: NewDocumentSequence[] = [];
  for (const doc of documents) {
    const { seq: sequence } = doc;
    const uid = parseSequenceId(doc);

    const documentSequence = {
      uid,
      docType: TOTAL_EXPECTED_VOTE,
      sequence,
    };

    sequences.push(documentSequence);
  }
  return sequences;
};

export default {
  parseTotalExpectedVotes,
  parseSequenceId,
  parseDocumentSequences,
};

[]

TypeScript coverage report