@fhss-web-team/fuzzy-dates 1.0.0

package/dist/fuzzyDate/parse/stringToDate.js

@@ -0,0 +1,24 @@
+import { err } from '../types';
+import { dayMonthDigitYear, dayMonthStringYear, decade, monthDigitYear, monthStringDayYear, monthStringYear, year, yearMonthDigitDay, yearDayMonthString, yearMonthDigit, yearMonthString, yearMonthStringDay, } from './inputDateFormats';
+export function stringToDate(dateInput) {
+    const parsers = [
+        year,
+        monthStringYear,
+        yearMonthString,
+        dayMonthStringYear,
+        monthStringDayYear,
+        yearMonthStringDay,
+        yearDayMonthString,
+        monthDigitYear,
+        yearMonthDigit,
+        dayMonthDigitYear,
+        yearMonthDigitDay,
+        decade,
+    ];
+    for (const parseFormat of parsers) {
+        const result = parseFormat(dateInput);
+        if (result)
+            return result;
+    }
+    return err('Unknown date format.');
+}

package/dist/fuzzyDate/types.d.ts

@@ -0,0 +1,79 @@
+type Ok<T> = {
+    ok: true;
+    value: T;
+};
+type Err<E = unknown> = {
+    ok: false;
+    error: E;
+};
+export type Result<T, E> = Ok<T> | Err<E>;
+export declare function ok<T = undefined>(value?: T): Ok<T>;
+export declare function err<E>(error: E): Err<E>;
+export declare const DATE_NEG_INFINITY: Date;
+export declare const DATE_POS_INFINITY: Date;
+export declare const FORMAT_ORDER: readonly ["YYYYs", "YYYY", "SEASON_YYYY", "MMMM_YYYY", "D_MMMM_YYYY"];
+export type NormalFormat = (typeof FORMAT_ORDER)[number];
+export declare const MODIFIER_ORDER: readonly ["BEFORE", "ABOUT", "NONE", "EARLY", "MID", "LATE", "FROM", "BETWEEN", "AFTER"];
+export type FuzzyDateModifier = (typeof MODIFIER_ORDER)[number];
+export type FuzzyDateValue = {
+    format: NormalFormat;
+    minDate: Date;
+    maxDate: Date;
+};
+export type FuzzyDateModel = {
+    original: string;
+    modifier: FuzzyDateModifier;
+    start: FuzzyDateValue;
+    end: FuzzyDateValue;
+};
+export declare const MONTH_SEASON_MAP: {
+    readonly spring: 3;
+    readonly summer: 6;
+    readonly fall: 9;
+    readonly autumn: 9;
+    readonly winter: 12;
+};
+export declare function isSeason(input: string): input is keyof typeof MONTH_SEASON_MAP;
+export declare const SEASON_MONTH_MAP: {
+    readonly 1: "winter";
+    readonly 2: "winter";
+    readonly 3: "spring";
+    readonly 4: "spring";
+    readonly 5: "spring";
+    readonly 6: "summer";
+    readonly 7: "summer";
+    readonly 8: "summer";
+    readonly 9: "fall";
+    readonly 10: "fall";
+    readonly 11: "fall";
+    readonly 12: "winter";
+};
+export declare function isSeasonMonth(input: number): input is keyof typeof SEASON_MONTH_MAP;
+export declare const MONTH_NAME_MAP: {
+    readonly jan: 1;
+    readonly january: 1;
+    readonly feb: 2;
+    readonly february: 2;
+    readonly mar: 3;
+    readonly march: 3;
+    readonly apr: 4;
+    readonly april: 4;
+    readonly may: 5;
+    readonly jun: 6;
+    readonly june: 6;
+    readonly jul: 7;
+    readonly july: 7;
+    readonly aug: 8;
+    readonly august: 8;
+    readonly sep: 9;
+    readonly sept: 9;
+    readonly september: 9;
+    readonly oct: 10;
+    readonly october: 10;
+    readonly nov: 11;
+    readonly november: 11;
+    readonly dec: 12;
+    readonly december: 12;
+};
+export declare function isMonth(input: string): input is keyof typeof MONTH_NAME_MAP;
+export {};

package/dist/fuzzyDate/types.js

@@ -0,0 +1,88 @@
+export function ok(value) {
+    return {
+        ok: true,
+        value,
+    };
+}
+export function err(error) {
+    return {
+        ok: false,
+        error,
+    };
+}
+export const DATE_NEG_INFINITY = new Date(-8640000000000000);
+export const DATE_POS_INFINITY = new Date(8640000000000000);
+export const FORMAT_ORDER = [
+    'YYYYs',
+    'YYYY',
+    'SEASON_YYYY',
+    'MMMM_YYYY',
+    'D_MMMM_YYYY',
+];
+export const MODIFIER_ORDER = [
+    'BEFORE',
+    'ABOUT',
+    'NONE',
+    'EARLY',
+    'MID',
+    'LATE',
+    'FROM',
+    'BETWEEN',
+    'AFTER',
+];
+export const MONTH_SEASON_MAP = {
+    spring: 3,
+    summer: 6,
+    fall: 9,
+    autumn: 9,
+    winter: 12,
+};
+export function isSeason(input) {
+    return Object.keys(MONTH_SEASON_MAP).includes(input);
+}
+export const SEASON_MONTH_MAP = {
+    1: 'winter',
+    2: 'winter',
+    3: 'spring',
+    4: 'spring',
+    5: 'spring',
+    6: 'summer',
+    7: 'summer',
+    8: 'summer',
+    9: 'fall',
+    10: 'fall',
+    11: 'fall',
+    12: 'winter',
+};
+export function isSeasonMonth(input) {
+    return input >= 1 && input <= 12;
+}
+export const MONTH_NAME_MAP = {
+    jan: 1,
+    january: 1,
+    feb: 2,
+    february: 2,
+    mar: 3,
+    march: 3,
+    apr: 4,
+    april: 4,
+    may: 5,
+    jun: 6,
+    june: 6,
+    jul: 7,
+    july: 7,
+    aug: 8,
+    august: 8,
+    sep: 9,
+    sept: 9,
+    september: 9,
+    oct: 10,
+    october: 10,
+    nov: 11,
+    november: 11,
+    dec: 12,
+    december: 12,
+};
+export function isMonth(input) {
+    return Object.keys(MONTH_NAME_MAP).includes(input);
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { FuzzyDate } from './fuzzyDate/fuzzyDate';

package/dist/index.js

@@ -0,0 +1 @@
+export { FuzzyDate } from './fuzzyDate/fuzzyDate';

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@fhss-web-team/fuzzy-dates",
+  "version": "1.0.0",
+  "description": "Parses imprecise date strings into a structured form that can be normalized, indexed, searched, and ordered while preserving the original input.",
+  "homepage": "https://github.com/FHSS-Web-Team/CFHG-fuzzy-dates#readme",
+  "bugs": {
+    "url": "https://github.com/FHSS-Web-Team/CFHG-fuzzy-dates/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FHSS-Web-Team/CFHG-fuzzy-dates.git"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "author": "",
+  "type": "module",
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "preversion": "npm run build",
+    "postversion": "git push",
+    "deploy": "npm run build && npm publish --access public"
+  },
+  "devDependencies": {
+    "prettier": "^3.6.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.0"
+  }
+}