documentKey.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/utils/documentKey.ts	100.00%	80%	115	115	0

import { getOfficeBodyUid } from './officeBodyUid.js';

/** Edison document key */
export interface GenericDocumentKey {
  st?: number;
  cnty?: number;
  jType?: string;
  jCde?: number;
  ofc?: string;
  eType?: string;
}

/**
 * Parse an Edison document key and return uids for models.
 */
export const parseKey = <T extends GenericDocumentKey>(key: T) => {
  const { st, cnty, jType, jCde, ofc, eType } = key;

  const electionType = eType || null;
  const state = st > 0 ? st : null;
  const county = state && cnty > 0 ? `${state}_${cnty}` : null;
  const jurisdictionType = jType || null;
  const jurisdiction = jurisdictionType
    ? `${st}_${jType}_${String(jCde).padStart(2, '0')}`
    : null;
  const jurisdictionRace =
    jurisdiction && electionType ? `${jurisdiction}_${electionType}` : null;
  const office = jurisdiction && ofc ? `${jurisdiction}_${ofc}` : null;
  const officeRace =
    office && electionType ? `${office}_${electionType}` : null;
  const officeBody = getOfficeBodyUid(ofc);
  const jurisdictionCode = jCde;

  return {
    electionType,
    state,
    county,
    jurisdictionType,
    jurisdictionCode,
    jurisdiction,
    jurisdictionRace,
    office,
    officeBody,
    officeRace,
  };
};

/**
 * Returns `office` unique ID by parsing and concatenating `jurisdiction` UID and `ofc` code. Use this when `jurisdiction` and `ofc` are not both defined inside the document `key`.
 *
 * @param jurisdiction The jurisdiction unique ID
 * @param ofc The office code
 */
export const parseOfficeUid = (
  jurisdiction: string,
  ofc: string
): string | null => {
  return jurisdiction && ofc ? `${jurisdiction}_${ofc}` : null;
};

/**
 * Returns `officeRace` unique ID by parsing and concatenating `office` and `election` UIDs. Use this when `office` and `election` are not both defined inside the document `key`.
 *
 * @param office The office unique ID
 * @param electionType The office code
 */
export const parseOfficeRaceUid = (
  office: string,
  electionType: string
): string | null => {
  return office && electionType ? `${office}_${electionType}` : null;
};

/**
 * Parse Edison keys and return a unique ID that represents the state and county. Use this method only when `st` and `cnty` are not both included in the document key. If both `st` and `cnty` are included in the document key, use `parseKey` instead to get the county UID.
 * @param st The Edison state code
 * @param cnty The Edison county code
 * @returns Unique ID for state and county
 */
export const parseCountyCode = (st: number, cnty: number): string | null => {
  const state = st > 0 ? st : null;
  const county = state && cnty > 0 ? `${state}_${cnty}` : null;
  return county;
};

/**
 * Returns a unique ID that represents the state and election type.
 * @param state The Edison state code
 * @param electionType The Edison election type code
 * @returns Unique ID for state and election type
 */
export const parseStateElectionTypeCode = (
  state: number,
  electionType: string
): string | null => {
  return state ? `${state}_${electionType}` : null;
};

/**
 * Returns a unique ID that represents the office body and election type.
 * @param officeBody The Edison officeBody code
 * @param electionType The Edison election type code
 * @returns Unique ID for officeBody and election type
 */
export const parseOfficeBodyElectionTypeCode = (
  officeBody: string,
  electionType: string
): string | null => {
  return officeBody && electionType ? `${officeBody}_${electionType}` : null;
};

/**
 * Returns `county` unique ID by parsing and concatenating `state` UID and `cnty` (county) code. Use this when `state` and `cnty` are not both defined inside the document `key`.
 *
 * @param state The state unique ID
 * @param cnty The county code
 * @returns Unique IDs defined from key
 */
export const parseCountyUid = (state: number, cnty: number): string | null => {
  return state && cnty > 0 ? `${state}_${cnty}` : null;
};

[]

TypeScript coverage report