@per-diem-calculator/vanilla 1.0.1 → 1.0.2

package/src/ts/utils/expenses/createExpenseObjs.ts

@@ -1,35 +0,0 @@
-// Types
-import type { StateLocationItemValid } from '../../types/locations';
-import type { StateExpenseItem } from '../../types/expenses';
-
-// Utils
-import { isDateRawType, getDateRaw } from '../dates';
-
-export const createExpenseObjs = (
-    location: StateLocationItemValid,
-): StateExpenseItem[] => {
-    const { start, end, country, city } = location;
-    const expenses: StateExpenseItem[] = [];
-    const currentDate = new Date(start);
-    const lastDate = new Date(end);
-    while (currentDate <= lastDate) {
-        const currentDateRaw = getDateRaw(currentDate.toISOString());
-        if (!isDateRawType(currentDateRaw))
-            throw new Error('Failed to create valid date.');
-        expenses.push({
-            date: currentDateRaw,
-            country: country,
-            city: city,
-            deductions: {
-                FirstLastDay: false,
-                breakfastProvided: false,
-                lunchProvided: false,
-                dinnerProvided: false,
-            },
-        });
-        currentDate.setUTCDate(currentDate.getUTCDate() + 1);
-    }
-    expenses[0].deductions.FirstLastDay = true;
-    expenses[expenses.length - 1].deductions.FirstLastDay = true;
-    return expenses;
-};

package/src/ts/utils/expenses/getLodgingRateDomestic.ts

@@ -1,73 +0,0 @@
-// Types
-import type { RateLodging, StateExpenseItem } from '../../types/expenses';
-import type { ShortMonth } from '../../types/dates';
-
-// Utils
-import { fetchJsonGSA } from '../fetch';
-import {
-    isDateRawType,
-    getValidAPIYear,
-    isShortMonth,
-    getShortMonth,
-    getYYYY,
-    getMM,
-} from '../dates';
-
-const getRate = (
-    expense: StateExpenseItem,
-    rates: RateLodging[],
-): RateLodging => {
-    const lodgingRate = rates.find(
-        rate =>
-            rate.State !== null &&
-            rate.State === expense.country &&
-            rate.City === expense.city,
-    );
-    if (!lodgingRate)
-        throw new Error(
-            'Failed to find lodging rate in fetched data from GSA.',
-        );
-    return lodgingRate;
-};
-
-const createStateExpenseItem = (
-    expense: StateExpenseItem,
-    lodgingRate: RateLodging,
-    lodgingMonth: ShortMonth,
-): StateExpenseItem => {
-    const effDate = `${getYYYY(expense.date)}-${getMM(expense.date)}-01`;
-    if (!isDateRawType(effDate))
-        throw new Error(
-            `Failed to create valid effective date for rate: ${expense.date} - ${expense.city}`,
-        );
-    return {
-        ...expense,
-        rates: {
-            maxLodging: +lodgingRate[lodgingMonth],
-            maxMie: +lodgingRate.Meals,
-            effDate,
-        },
-    };
-};
-
-export const getLodgingRateDomestic = async (
-    expense: StateExpenseItem,
-): Promise<StateExpenseItem> => {
-    try {
-        const date = new Date(expense.date);
-        const lodgingMonth = getShortMonth(date.toUTCString());
-        if (!isShortMonth(lodgingMonth))
-            throw new Error('Invalid month for fetching rates from GSA.');
-
-        return await fetchJsonGSA<RateLodging>(
-            getValidAPIYear(expense.date),
-            'lodging',
-        )
-            .then(rates => getRate(expense, rates))
-            .then(rate => createStateExpenseItem(expense, rate, lodgingMonth));
-    } catch (error) {
-        throw new Error(
-            `Failed to get lodging rate for ${expense.date} = ${expense.city} - ${error}`,
-        );
-    }
-};

package/src/ts/utils/expenses/getLodgingRateIntl.ts

@@ -1,119 +0,0 @@
-// Types
-import type { StateExpenseItem } from '../../types/expenses';
-import type { DateRaw } from '../../types/dates';
-
-// Utils
-import { fetchXmlDOD, parseXml } from '../fetch';
-import { parseIntlLodgingRates } from './parseIntlLodgingRates';
-import { getValidAPIYear, isDateRawType, getYYYY, getDateRaw } from '../dates';
-
-const getRecords = async (expense: StateExpenseItem): Promise<Element[]> => {
-    const data = await fetchXmlDOD(getValidAPIYear(expense.date));
-    if (!data) throw new Error(`Error getting rates from XML`);
-    return parseXml(
-        data,
-        `//record[location_name[text()="${expense.city}"]]`,
-    ) as Element[];
-};
-
-const getRecord = (expense: StateExpenseItem, records: Element[]) => {
-    const { date, country, city } = expense;
-    const record = parseIntlLodgingRates(date, country, records);
-    if (!record)
-        throw new Error(
-            `Failed to pull intl rate from XML records for ${date}: ${country} - ${city}.`,
-        );
-    return record;
-};
-
-const getRecordEls = (record: Element) => {
-    const lodgingText = record.querySelector('lodging_rate')?.textContent;
-    const mieText = record.querySelector('local_meals')?.textContent;
-    const rateStartDateText = record.querySelector('start_date')?.textContent;
-
-    if (!(lodgingText && mieText && rateStartDateText))
-        throw new Error(
-            'Failed to pull lodging rate, mie rate, effective date from XML records.',
-        );
-
-    return { lodgingText, mieText, rateStartDateText };
-};
-
-const createRatesObj = (
-    dateRaw: DateRaw,
-    lodgingText: string,
-    mieText: string,
-    rateStartDateText: string,
-) => {
-    const maxLodging = +lodgingText;
-    const maxMie = +mieText;
-
-    // OCONUS has different rates with the same effective date but different season start/end dates
-    // We'll create an effective date based on the rate's season start date, and reduce the year by 1 if it's newer than the trip date
-    const rateStartDate = new Date(
-        `${getYYYY(dateRaw)}-${rateStartDateText.replaceAll('/', '-')}`,
-    );
-    const tripDate = new Date(dateRaw);
-    if (tripDate < rateStartDate)
-        rateStartDate.setUTCFullYear(+getYYYY(dateRaw) - 1);
-    const effDate = getDateRaw(rateStartDate.toISOString());
-
-    if (!isDateRawType(effDate))
-        throw new Error(
-            `Failed to create valid effective date for ${dateRaw} `,
-        );
-
-    return {
-        maxLodging,
-        maxMie,
-        effDate,
-    };
-};
-
-const createStateExpenseItem = (
-    expense: StateExpenseItem,
-    maxLodging: number,
-    maxMie: number,
-    effDate: DateRaw,
-): StateExpenseItem => {
-    return {
-        ...expense,
-        rates: {
-            maxLodging,
-            maxMie,
-            effDate,
-        },
-    };
-};
-
-export const getLodgingRateIntl = async (
-    expense: StateExpenseItem,
-): Promise<StateExpenseItem> => {
-    try {
-        return await getRecords(expense)
-            .then(records => getRecord(expense, records))
-            .then(record => getRecordEls(record))
-            .then(recordEls => {
-                const { lodgingText, mieText, rateStartDateText } = recordEls;
-                return createRatesObj(
-                    expense.date,
-                    lodgingText,
-                    mieText,
-                    rateStartDateText,
-                );
-            })
-            .then(ratesObj => {
-                const { maxLodging, maxMie, effDate } = ratesObj;
-                return createStateExpenseItem(
-                    expense,
-                    maxLodging,
-                    maxMie,
-                    effDate,
-                );
-            });
-    } catch (error) {
-        throw new Error(
-            `Failed to get lodging rate for ${expense.date} - ${expense.city} - ${error}`,
-        );
-    }
-};

package/src/ts/utils/expenses/getMieRates.ts

@@ -1,84 +0,0 @@
-// Types
-import type {
-    RateMeals,
-    ExpenseRates,
-    StateExpenseItem,
-    StateExpenseItemInclRates,
-} from '../../types/expenses';
-
-// Utils
-import { fetchJsonGSA } from '../fetch';
-import { INTL_MIE_RATES } from './INTL_MIE_RATES';
-import { getValidAPIYear } from '../dates';
-import { US_STATE_LENGTH } from '../config';
-
-const getMealsRate = async (expense: StateExpenseItem): Promise<RateMeals> => {
-    if (!expense.rates?.maxMie)
-        throw new Error(
-            `Failed to get M&IE rates for ${expense.date} - ${expense.city} due to missing rate/deduction information in the expense object.`,
-        );
-    const mealsRates =
-        expense.country.length === US_STATE_LENGTH ?
-            await fetchJsonGSA<RateMeals>(getValidAPIYear(expense.date), 'mie')
-        :   INTL_MIE_RATES;
-    const rate = mealsRates.find(rate => rate.total === expense.rates?.maxMie);
-    if (!rate)
-        throw new Error('Failed to find meal rates that matched total MIE.');
-    return rate;
-};
-
-const createRatesObject = (
-    expense: StateExpenseItem,
-    mealsRate: RateMeals,
-): Required<ExpenseRates> => {
-    if (!expense.rates?.maxMie)
-        throw new Error(
-            `Failed to get M&IE rates for ${expense.date} - ${expense.city} due to missing rate/deduction information in the expense object.`,
-        );
-    return {
-        ...expense.rates,
-        maxMieFirstLast: mealsRate.FirstLastDay,
-        deductionBreakfast: mealsRate.breakfast,
-        deductionLunch: mealsRate.lunch,
-        deductionDinner: mealsRate.dinner,
-        maxIncidental: mealsRate.incidental,
-    };
-};
-
-const createStateExpenseItem = (
-    expense: StateExpenseItem,
-    rates: Required<ExpenseRates>,
-    expensesCategory: string,
-): StateExpenseItemInclRates => {
-    const lodgingAmount = expensesCategory === 'mie' ? 0 : rates.maxLodging;
-    const mieAmount =
-        expensesCategory === 'lodging' ? 0
-        : expense.deductions.FirstLastDay ? rates.maxMieFirstLast
-        : rates.maxMie;
-    const totalAmount = lodgingAmount + mieAmount;
-
-    return {
-        ...expense,
-        rates,
-        lodgingAmount,
-        mieAmount,
-        totalAmount,
-    };
-};
-
-export const getMieRates = async (
-    expensesCategory: string,
-    expense: StateExpenseItem,
-): Promise<StateExpenseItemInclRates> => {
-    try {
-        return await getMealsRate(expense)
-            .then(mealsRate => createRatesObject(expense, mealsRate))
-            .then(rates =>
-                createStateExpenseItem(expense, rates, expensesCategory),
-            );
-    } catch (error) {
-        throw new Error(
-            `Failed to get mie rates for ${expense.date} - ${expense.city} - ${error}`,
-        );
-    }
-};

package/src/ts/utils/expenses/index.ts

@@ -1,5 +0,0 @@
-export { createExpenseObjs } from './createExpenseObjs';
-export { getLodgingRateDomestic } from './getLodgingRateDomestic';
-export { getLodgingRateIntl } from './getLodgingRateIntl';
-export { getMieRates } from './getMieRates';
-export { returnValidStateExpense } from './returnValidStateExpense';

package/src/ts/utils/expenses/parseIntlLodgingRates.ts

@@ -1,124 +0,0 @@
-// Types
-import type { DateRaw } from '../../types/dates';
-
-// Utils
-import { getYYYY } from '../dates';
-
-const getRecordValues = (record: Element) => {
-    const countryText = record.querySelector('country_name')?.textContent;
-    const effDateText = record.querySelector('eff_date')?.textContent;
-    const expDateText = record.querySelector('exp_date')?.textContent;
-    const startDateText = record.querySelector('start_date')?.textContent;
-    const endDateText = record.querySelector('end_date')?.textContent;
-    if (
-        !(
-            countryText &&
-            effDateText &&
-            expDateText &&
-            startDateText &&
-            endDateText
-        )
-    )
-        throw new Error(
-            'Failed to pull country_name, eff_date, exp_date, start_date, end_date from XML records.',
-        );
-    return {
-        countryText,
-        effDateText,
-        expDateText,
-        startDateText,
-        endDateText,
-    };
-};
-
-const getRecordDates = (
-    year: string,
-    dateRaw: DateRaw,
-    effDateText: string,
-    expDateText: string,
-    startDateText: string,
-    endDateText: string,
-) => {
-    // Create dates from all record elements
-    // start_date and end_date don't have years, so we artificially add them
-    // e.g. 01/15 -> 2024-01-15
-    const date = new Date(dateRaw);
-    const effDate = new Date(
-        `${effDateText.split('/')[2]}-${effDateText.split('/')[0]}-${effDateText.split('/')[1]}`,
-    );
-    const expDate = new Date(
-        `${expDateText.split('/')[2]}-${expDateText.split('/')[0]}-${expDateText.split('/')[1]}`,
-    );
-    const startDate = new Date(`${year}-${startDateText?.replace('/', '-')}`);
-    const endDate = new Date(`${year}-${endDateText?.replace('/', '-')}`);
-    if (!(date && effDate && expDate && startDate && endDate))
-        throw new Error(
-            'Failed to create Date objects using date columns from XML records.',
-        );
-
-    return { date, effDate, expDate, startDate, endDate };
-};
-
-export const parseIntlLodgingRates = (
-    dateRaw: DateRaw,
-    country: string,
-    records: Element[],
-) => {
-    return records.find(record => {
-        const year = getYYYY(dateRaw);
-
-        // Get record elements
-        const {
-            countryText,
-            effDateText,
-            expDateText,
-            startDateText,
-            endDateText,
-        } = getRecordValues(record);
-
-        // If it's not the country, no need to proceed further
-        if (countryText !== country) return false;
-
-        // Get dates from elements
-        const { date, effDate, expDate, startDate, endDate } = getRecordDates(
-            year,
-            dateRaw,
-            effDateText,
-            expDateText,
-            startDateText,
-            endDateText,
-        );
-
-        // If trip date not after eff_date or trip date not before exp_date, no need to proceed further
-        if (!(date >= effDate && date <= expDate)) return false;
-
-        if (endDate < startDate) {
-            // Some rates are effective from end of one year to start of next
-            // e.g. 09/01 to 04/30
-            // Previous step set start_date, end_date to the trip date year
-            // e.g. trip date 09/02/22, start_date 09/01/22, 04/30/22.
-            // This step checks two variations, one where start_date changed, another where end_date changed, and returns true if trip date falls within either one
-            // e.g. check against both 09/01/22 to 04/30/23, and 09/01/21 to 04/30/22
-
-            // date 09/02/22, start 09/01/22, end 04/30/23
-            endDate.setUTCFullYear(+year + 1);
-            if (date >= startDate && date <= endDate) return true;
-
-            // date 09/02/22, start 09/01/21, end 04/30/22
-            startDate.setUTCFullYear(+year - 1);
-            endDate.setUTCFullYear(+year);
-            if (date >= startDate && date <= endDate) return true;
-        }
-
-        if (date >= startDate && date <= endDate) return true;
-
-        return false;
-    });
-};
-
-// Logging to check how rates are being parsed
-// console.log(`______Date: ${date.toISOString().slice(0, 10)}`);
-// console.log(`start_Date: ${startDate.toISOString().slice(0, 10)}`);
-// console.log(`end___Date: ${endDate.toISOString().slice(0, 10)}`);
-// console.log(`Checking if date >= start_Date && date <= end_Date`);
-// console.log(date >= startDate && date <= endDate);

package/src/ts/utils/expenses/returnValidStateExpense.ts

@@ -1,46 +0,0 @@
-// Types
-import type {
-    StateExpenseItemInclRates,
-    StateExpenseItemValid,
-} from '../../types/expenses';
-import type { DateRaw } from '../../types/dates';
-
-// Utils
-import { getYYYY, getYY, getMM } from '../dates';
-import { OCTOBER } from '../config';
-
-const getGSAFiscalYear = (date: DateRaw) => {
-    return +getMM(date) < OCTOBER ? +getYYYY(date) : +getYYYY(date) + 1;
-};
-
-const getDODSourceDate = (date: DateRaw) => {
-    const todayDate = new Date();
-    const todayMonth = getMM(todayDate.toISOString());
-    const todayYear = getYYYY(todayDate.toISOString());
-
-    const tripMonth = getMM(date);
-    const tripYear = getYYYY(date);
-
-    const sourceYear =
-        +tripYear > +todayYear ? getYY(todayDate.toISOString()) : getYY(date);
-    const sourceMonth =
-        +tripYear > +todayYear ? todayMonth
-        : +tripMonth > +todayMonth ? todayMonth
-        : tripMonth;
-
-    return `${sourceMonth}-01-${sourceYear}`;
-};
-
-export const returnValidStateExpense = (
-    expense: StateExpenseItemInclRates,
-): StateExpenseItemValid => {
-    const { date, country, city } = expense;
-    let source = '';
-    if (expense.country.length === 2)
-        // Domestic rates are state abbr like 'NY' with length 2
-        source = `https://www.gsa.gov/travel/plan-book/per-diem-rates/per-diem-rates-results?action=perdiems_report&fiscal_year=${getGSAFiscalYear(date)}&state=${country}&city=${city}`;
-    else
-        source = `https://www.defensetravel.dod.mil/neorates/report/index.php?report=oconus&country=${country}&date=${getDODSourceDate(date)}&military=YES`;
-
-    return { ...expense, source };
-};

package/src/ts/utils/fetch/fetchJsonGSA.ts

@@ -1,29 +0,0 @@
-// Types
-import type { YYYY } from '../../types/dates';
-
-// Utils
-import { memoize } from './memoize';
-
-const PROXY_URL = import.meta.env.VITE_PROXY_URL;
-const PROXY_KEY = import.meta.env.VITE_PROXY_KEY;
-const GSA_API_URL = 'https://api.gsa.gov/travel/perdiem/v2/rates/conus';
-
-const fetchJsonGSA = async <T>(
-    year: YYYY,
-    type: 'lodging' | 'mie',
-): Promise<T[]> => {
-    const url = `${PROXY_URL}?url=${GSA_API_URL}/${type}/${year}`;
-    const res = await fetch(url, {
-        method: 'GET',
-        headers: {
-            'x-perdiem-key': PROXY_KEY,
-        },
-    });
-    if (!res.ok) throw new Error(`Failed to get API results from ${url}.`);
-    const result = await res.json();
-    return result;
-};
-
-const fetchJsonGSAMemo = memoize(fetchJsonGSA);
-
-export { fetchJsonGSAMemo as fetchJsonGSA };

package/src/ts/utils/fetch/fetchXmlDOD.ts

@@ -1,38 +0,0 @@
-// Types
-import type { YYYY } from '../../types/dates';
-
-// Utils
-import JSZip from 'jszip';
-import { memoize } from './memoize';
-import { getYY } from '../dates';
-
-const PROXY_URL = import.meta.env.VITE_PROXY_URL;
-const PROXY_KEY = import.meta.env.VITE_PROXY_KEY;
-const DOD_XML_URL = `https://www.travel.dod.mil/Portals/119/Documents/Allowances/Per_Diem/OCONUS/REL/OCONUS-REL-API_YEAR_FROM_MODEL.zip`;
-
-// Download relational zip file from US DOD (https://www.travel.dod.mil/Travel-Transportation-Rates/Per-Diem/Per-Diem-Rate-Lookup/) -> unzip the XML file with JSZip
-const fetchXmlDOD = async (year: YYYY) => {
-    const url = `${PROXY_URL}?url=${DOD_XML_URL.replace('API_YEAR_FROM_MODEL', year)}`;
-    const res = await fetch(url, {
-        headers: {
-            'x-perdiem-key': PROXY_KEY,
-        },
-    });
-    if (!res.ok) throw new Error(`Failed to download file from ${url}`);
-
-    const resFile = await res.arrayBuffer();
-    if (!resFile)
-        throw new Error(`Failed to write file from ${url} to arrayBuffer`);
-
-    const zip = new JSZip();
-    await zip.loadAsync(resFile);
-    const filename = `ocallhist-${getYY(year, 'YYYY')}.xml`;
-    const data = await zip.file(filename)?.async('string');
-    if (!data)
-        throw new Error(`Failed to extract XML file from zip from ${url}`);
-    return data;
-};
-
-const fetchXmlDODmemo = memoize(fetchXmlDOD);
-
-export { fetchXmlDODmemo as fetchXmlDOD };

package/src/ts/utils/fetch/index.ts

@@ -1,3 +0,0 @@
-export { fetchXmlDOD } from './fetchXmlDOD';
-export { fetchJsonGSA } from './fetchJsonGSA';
-export { parseXml } from './parseXml';

package/src/ts/utils/fetch/memoize.ts

@@ -1,46 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
-export function memoize<
-    F extends <T extends any>(...args: [T, ...any[]]) => ReturnType<F>,
->(fn: F): F;
-export function memoize<F extends (...args: any[]) => ReturnType<F>>(fn: F): F;
-export function memoize<
-    F extends <T extends any>(...args: [T, ...any[]]) => ReturnType<F>,
->(fn: F): F {
-    let lastArgs: unknown[] = [];
-    let lastResult: ReturnType<F>;
-    let calledOnce = false;
-
-    /**
-     * Compare arguments for shallow identity equality.
-     */
-    const argsEqual = (a: unknown[], b: unknown[]): boolean => {
-        if (a.length !== b.length) {
-            return false;
-        }
-
-        for (let i = 0; i < a.length; i++) {
-            if (a[i] !== b[i]) {
-                return false;
-            }
-        }
-        return true;
-    };
-
-    /**
-     * Wrap function in memoized function.
-     */
-    const memoized = <U extends any>(
-        ...newArgs: [U, ...any[]]
-    ): ReturnType<F> => {
-        if (!calledOnce || !argsEqual(lastArgs, newArgs)) {
-            const newResult = fn(...newArgs);
-            lastResult = newResult;
-            lastArgs = newArgs;
-            calledOnce = true;
-        }
-        return lastResult;
-    };
-
-    return memoized as F;
-}

package/src/ts/utils/fetch/parseXml.ts

@@ -1,19 +0,0 @@
-import { memoize } from './memoize';
-
-// Turn XML into readable DOM with DOMParser and use XPathEvaluator to do the equivalent of querySelectoring text inside an element
-// https://developer.mozilla.org/en-US/docs/Web/XML/XPath/Guides/Snippets
-const parseXml = (data: string, aExpr: string) => {
-  const parser = new DOMParser();
-  const aNode = parser.parseFromString(data, 'application/xml');
-  const xpe = new XPathEvaluator();
-  const nsResolver = aNode.documentElement;
-  const result = xpe.evaluate(aExpr, aNode, nsResolver, 0, null);
-  const found = [];
-  let res;
-  while ((res = result.iterateNext())) found.push(res);
-  return found;
-};
-
-const parseXmlMemo = memoize(parseXml);
-
-export { parseXmlMemo as parseXml };

package/src/ts/utils/locations/getCitiesDomestic.ts

@@ -1,48 +0,0 @@
-// Types
-import type { Location } from '../../types/locations';
-import type { RateLodging } from '../../types/expenses';
-import type { DateRaw } from '../../types/dates';
-
-// Utils
-import { fetchJsonGSA } from '../fetch';
-import { getValidAPIYear } from '../dates';
-import { sortLocations } from './sortLocations';
-import { keepUniqueLocations } from './keepUniqueLocations';
-
-const getCities = (data: RateLodging[], country: string): RateLodging[] => {
-    return data.filter(
-        rate =>
-            rate.State !== null &&
-            rate.State !== '' &&
-            rate.State.toLowerCase() === country.toLowerCase(),
-    );
-};
-
-const createLocations = (data: RateLodging[], country: string): Location[] => {
-    return data.map(rate => {
-        return rate.County === null ?
-                { city: rate.City, country: country, label: rate.City }
-            :   {
-                    city: rate.City,
-                    country: country,
-                    label: `${rate.City} / ${rate.County}`,
-                };
-    });
-};
-
-export const getCitiesDomestic = async (
-    date: DateRaw,
-    country: string,
-): Promise<Location[]> => {
-    try {
-        return await fetchJsonGSA<RateLodging>(getValidAPIYear(date), 'lodging')
-            .then(data => getCities(data, country))
-            .then(data => createLocations(data, country))
-            .then(data => sortLocations(data, 'city', 'domesticCities'))
-            .then(data => keepUniqueLocations(data, 'city'));
-    } catch (error) {
-        throw new Error(
-            `Failed to get domestic cities for ${date} - ${country} - ${error}`,
-        );
-    }
-};