index.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/results/parsers/delegate-allocation/index.ts	98.11%	80%	159	156	3

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

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

/**
 * Parses documents we get from querying the `results/delegate-allocation` endpoint. It then transforms the data to fit the structure of the DelegateAllocation model and returns an array of objects that can be upserted into the model.
 */
const parseDelegateAllocations = (documents: Document[]) => {
  const instances: NewDelegateAllocation[] = [];
  for (const doc of documents) {
    const {
      candidates,
      cnty,
      dist, // May not be provided by Edison
      pctsRep: totalPrecinctsReportingSoFar, // from ElectionTonight API documentation on results/county-vote
      proOut: provisionalVoteOutstanding,
      scp,
      seq: sequence,
      totPcts: totalPrecincts, // from ElectionTonight API documentation on results/county-vote
      totVote: totalVote,
      transSrc,
      ts,
    } = doc;
    const {
      electionType,
      jurisdiction,
      jurisdictionCode,
      jurisdictionRace,
      jurisdictionType,
      office,
      officeRace,
      state,
    } = parseKey(doc.key);
    const county = parseCountyCode(state, cnty);
    const { ofc: officeCode, eDate } = doc.key;

    /**
     * @TODO Do we really need this check?? When/how does this fail? --Jon
     */
    // Check that the document does not contain national data
    const isNational = state === null; // Should always be null since primaries delegate allocation data are state-level

    if (isNational === true)
      throw new Error(
        `Delegate allocation data is statewide or by district and should not have national data. isNational is ${isNational} instead`
      );

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

    for (const c of candidates) {
      const { cId: candidate, cVote: delegatesAllocated } = c;
      const candidateRace = `${officeRace}_${candidate}`;

      const instance: NewDelegateAllocation = {
        uid: candidateRace,
        candidate,
        candidateRace,
        county, // Should always be null since this data is statewide or district-level. We potentially can get rid of this foreign key association.
        electionType, // D or R for Dem/Rep primaries
        jurisdiction,
        jurisdictionRace,
        jurisdictionType,
        office,
        officeRace,
        state,
        state_electionType: parseStateElectionTypeCode(state, electionType),

        // Delegate allocation data
        delegatesAllocated,

        // Optional district info
        districtId: dist?.dId,
        districtType: prettifyDistrictTypeCodes(dist?.dType),

        // Summary/national flags
        isSummary: scp === 'S',
        isNational, // Should always be false since this data is statewide or district-level. Can potentially get rid of this field.

        // Precinct info
        totalPrecinctsReportingSoFar,
        totalPrecincts,

        // Vote info
        provisionalVoteOutstanding,
        totalVote,
        transmissionSource: prettifyTransmissionSourceTypeCodes(transSrc),

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

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

      instances.push(instance);
    }
  }
  return instances;
};

/**
 * @param {ApiSchemas['delegate-allocation']} doc
 */
const parseSequenceId = (doc) => {
  const { officeRace } = parseKey(doc.key);
  return officeRace;
};

export default {
  parseDelegateAllocations,
  parseSequenceId,
};

[{"file":"src/results/parsers/delegate-allocation/index.ts","line":136,"character":25,"text":"doc","kind":1},{"file":"src/results/parsers/delegate-allocation/index.ts","line":137,"character":34,"text":"doc","kind":1},{"file":"src/results/parsers/delegate-allocation/index.ts","line":137,"character":38,"text":"key","kind":1}]

TypeScript coverage report