remove most augment functions into augment-vir

Use augment-vir package in place of having all these one-off augments.

README.md

@@ -260,5 +260,3 @@ If you find that your statement PDF is coming from a bank or credit card that th
 3. Add new `runTest` calls for the tests you want to add.
 
 See other test files for examples, such as [`array.test.ts`](https://github.com/electrovir/statement-parser/tree/master/src/augments/array.test.ts).
-
-> v2.0.0

package.json

@@ -1,6 +1,6 @@
 {
     "name": "statement-parser",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "description": "Parse bank and credit card statements.",
     "keywords": [
         "pdf",
@@ -36,18 +36,19 @@
     "main": "dist/src/index.js",
     "typings": "dist/src/index.d.ts",
     "scripts": {
-        "format": "virmator format write",
+        "format": "virmator format",
         "prepublishOnly": "npm run test:full",
         "sanitize": "virmator compile && node dist/sanitizer/sanitize-for-test-file-cli.js",
         "sanitize:all": "./bulk-sanitize.sh files/downloads",
         "sanitize:no-compile": "node dist/sanitizer/sanitize-for-test-file-cli.js",
         "spellcheck": "virmator spellcheck",
-        "update-docs": "virmator code-in-markdown README.md",
         "test": "virmator test",
         "test:file": "./test-specific-file.sh",
-        "test:full": "npm run test && npm run spellcheck && npm run format check"
+        "test:full": "npm run test && npm run spellcheck && npm run format check && npm run update-docs -- --check",
+        "update-docs": "virmator code-in-markdown README.md"
     },
     "dependencies": {
+        "augment-vir": "^1.3.0",
         "fs-extra": "^10.0.0",
         "fsm-vir": "^1.0.1",
         "pdf-text-reader": "^3.0.0",

src/augments/date.ts

@@ -1,79 +1,18 @@
+import {createDateFromUtcIsoFormat} from 'augment-vir';
 import {isSanitizerMode} from '../global';
-const longMonthNames = [
-    'january',
-    'february',
-    'march',
-    'april',
-    'may',
-    'june',
-    'july',
-    'august',
-    'september',
-    'october',
-    'november',
-    'december',
-];
-
-const shortMonthNames = longMonthNames.map((longMonthName) => longMonthName.slice(0, 3));
-
-export class InvalidDateError extends Error {
-    public override readonly name = 'InvalidDateError';
-}
-
-export function dateFromSlashFormat(input: string, yearPrefix: number | string = '') {
-    const [month, day, rawYearEnding = ''] = input.split('/');
-
-    if (!month || !day) {
-        throw new Error(`Unable to extract month or day from "${input}"`);
-    }
-
-    const yearEnding =
-        rawYearEnding.length < 4 ? `${yearPrefix}${rawYearEnding.padStart(2, '0')}` : rawYearEnding;
-
-    const returnDate = createUtcDate(
-        `${yearEnding.padStart(4, '0')}-${month.padStart(2, '0')}-${day.padStart(2, '0')}`,
-    );
-    return returnDate;
-}
-
-export function dateFromNamedCommaFormat(input: string) {
-    const [monthName, dayNumber, fullYear] = input.replace(',', '').split(' ');
-    if (!monthName || !dayNumber || !fullYear) {
-        throw new InvalidDateError(`Invalid ${dateFromNamedCommaFormat.name} input: ${input}`);
-    }
-
-    const longMonthIndex = longMonthNames.indexOf(monthName.toLowerCase());
-    const shortMonthIndex = shortMonthNames.indexOf(monthName.toLowerCase());
-
-    let monthIndex = longMonthIndex === -1 ? shortMonthIndex : longMonthIndex;
-
-    if (monthIndex === -1) {
-        if (isSanitizerMode()) {
-            monthIndex = 4;
-        } else {
-            throw new InvalidDateError(`Month name ${monthName} was not found.`);
-        }
-    }
-
-    const returnDate = createUtcDate(
-        `${fullYear.padStart(4, '0')}-${String(monthIndex + 1).padStart(
-            2,
-            '0',
-        )}-${dayNumber.padStart(2, '0')}`,
-    );
-
-    return returnDate;
-}
-
-export function createUtcDate(isoFormatString: string) {
-    const utcDate = new Date(isoFormatString + 'T00:00:00.000Z');
-
-    if (isNaN(Number(utcDate))) {
-        throw new InvalidDateError(`Invalid utc date formed from input "${isoFormatString}"`);
-    }
-    return utcDate;
-}
 
+/**
+ * Creates a date object that's between the two dates given. If a valid date cannot be created with
+ * the given inputs, a date is created that is at least earlier than the given endDate.
+ *
+ * @param startDate Optional. The earlier (date wise) bounds for creating the new Date object. If
+ *   this is not provided, a date is created that is as close to, but earlier than, the given endDate.
+ * @param endDate Required. The later bounds for creating the new Date object.
+ * @param monthNumber Month number for the new Date object. This is 1 indexed. So a `1` here
+ *   corresponds to January.
+ * @param dayNumber Number for the month for the new Date object. This is 1 indexed; the first day
+ *   of the mont is `1`.
+ */
 export function dateWithinRange(
     startDate: Date | undefined,
     endDate: Date,
@@ -90,18 +29,22 @@ export function dateWithinRange(
     const day = dayNumber < 10 ? `0${dayNumber}` : String(dayNumber);
 
     if (!startDate || startDate.getUTCFullYear() === endDate.getUTCFullYear()) {
-        const newDate = createUtcDate(`${endDate.getUTCFullYear()}-${month}-${day}`);
+        const newDate = createDateFromUtcIsoFormat(`${endDate.getUTCFullYear()}-${month}-${day}`);
         if (newDate <= endDate) {
             return newDate;
         } else {
-            return createUtcDate(`${endDate.getUTCFullYear() - 1}-${month}-${day}`);
+            return createDateFromUtcIsoFormat(`${endDate.getUTCFullYear() - 1}-${month}-${day}`);
         }
     } else if (startDate) {
-        const dateFromStartYear = createUtcDate(`${startDate.getUTCFullYear()}-${month}-${day}`);
-        const dateFromStartYearPlus = createUtcDate(
+        const dateFromStartYear = createDateFromUtcIsoFormat(
+            `${startDate.getUTCFullYear()}-${month}-${day}`,
+        );
+        const dateFromStartYearPlus = createDateFromUtcIsoFormat(
             `${startDate.getUTCFullYear() + 1}-${month}-${day}`,
         );
-        const dateFromEndYear = createUtcDate(`${endDate.getUTCFullYear()}-${month}-${day}`);
+        const dateFromEndYear = createDateFromUtcIsoFormat(
+            `${endDate.getUTCFullYear()}-${month}-${day}`,
+        );
         if (dateFromStartYear <= endDate && startDate <= dateFromStartYear) {
             return dateFromStartYear;
         } else if (dateFromEndYear <= endDate && startDate <= dateFromEndYear) {