temporal-fmt 0.8.2 → 0.8.4

package/dist/isoWeek.d.ts

@@ -0,0 +1,7 @@
+export declare function isGregorianLeapYear(year: number): boolean;
+export declare function dayOfYear(year: number, month: number, day: number): number;
+export interface IsoWeekDate {
+    isoYear: number;
+    week: number;
+}
+export declare function isoWeekYearAndWeek(year: number, month: number, day: number, dayOfWeek: number): IsoWeekDate;

package/dist/localeVocab.d.cts

@@ -5,5 +5,32 @@ export interface LocaleVocab {
     weekdayShort: string[];
     dayPeriod: string[];
 }
+/**
+ * Supply a custom month/weekday/day-period vocabulary for a locale key,
+ * overriding the Intl-derived vocab this library would otherwise build
+ * for that key. Useful for locales Intl doesn't cover well — the README's
+ * known-limitations section calls out the Hebrew leap-month gap as a
+ * specific case this addresses.
+ *
+ * Throws descriptively on malformed input (wrong array lengths, empty
+ * strings, duplicate entries, missing fields) rather than failing later
+ * during format/parse.
+ *
+ * Registered vocab takes precedence over the Intl-derived vocab for that
+ * locale key, including for already-cached entries — registering
+ * invalidates the prior cache entry for that locale so the next call
+ * picks up the new vocab.
+ *
+ * @example
+ * registerLocaleVocab('en-u-ca-hebrew-leap', {
+ *   monthLong: ['Nisan','Iyar','Sivan','Tammuz','Av','Elul','Tishrei','Marcheshvan','Kislev','Tevet','Shevat','Adar I','Adar II'],
+ *   monthShort: ['Nis','Iyy','Siv','Tam','Av','Elu','Tish','Chesh','Kis','Tev','Shv','Ad1','Ad2'],
+ *   weekdayLong: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
+ *   weekdayShort: ['Mon','Tue','Wed','Thu','Fri','Sat','Sun'],
+ *   dayPeriod: ['AM','PM'],
+ * });
+ */
+export declare function registerLocaleVocab(locale: string, vocab: Partial<LocaleVocab>): void;
 export declare function canonicalCacheKey(locale: string): string;
+export declare function getCustomVocab(locale: string): LocaleVocab | undefined;
 export declare function getLocaleVocab(locale: string): LocaleVocab;

package/dist/localeVocab.d.ts

@@ -5,5 +5,32 @@ export interface LocaleVocab {
     weekdayShort: string[];
     dayPeriod: string[];
 }
+/**
+ * Supply a custom month/weekday/day-period vocabulary for a locale key,
+ * overriding the Intl-derived vocab this library would otherwise build
+ * for that key. Useful for locales Intl doesn't cover well — the README's
+ * known-limitations section calls out the Hebrew leap-month gap as a
+ * specific case this addresses.
+ *
+ * Throws descriptively on malformed input (wrong array lengths, empty
+ * strings, duplicate entries, missing fields) rather than failing later
+ * during format/parse.
+ *
+ * Registered vocab takes precedence over the Intl-derived vocab for that
+ * locale key, including for already-cached entries — registering
+ * invalidates the prior cache entry for that locale so the next call
+ * picks up the new vocab.
+ *
+ * @example
+ * registerLocaleVocab('en-u-ca-hebrew-leap', {
+ *   monthLong: ['Nisan','Iyar','Sivan','Tammuz','Av','Elul','Tishrei','Marcheshvan','Kislev','Tevet','Shevat','Adar I','Adar II'],
+ *   monthShort: ['Nis','Iyy','Siv','Tam','Av','Elu','Tish','Chesh','Kis','Tev','Shv','Ad1','Ad2'],
+ *   weekdayLong: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
+ *   weekdayShort: ['Mon','Tue','Wed','Thu','Fri','Sat','Sun'],
+ *   dayPeriod: ['AM','PM'],
+ * });
+ */
+export declare function registerLocaleVocab(locale: string, vocab: Partial<LocaleVocab>): void;
 export declare function canonicalCacheKey(locale: string): string;
+export declare function getCustomVocab(locale: string): LocaleVocab | undefined;
 export declare function getLocaleVocab(locale: string): LocaleVocab;

package/dist/parseRelative.d.cts

@@ -0,0 +1,25 @@
+import { type FormatOptions } from './tokens.cjs';
+export interface ParseRelativeOptions extends FormatOptions {
+}
+/**
+ * Resolve common English relative-date phrases against a reference date,
+ * returning a Temporal.PlainDate. Supported phrases (English only):
+ *
+ * - weekday refs: "next Tuesday", "last Friday", "this Monday"
+ * - day offsets: "today", "tomorrow", "yesterday"
+ * - unit offsets: "in 3 days", "2 weeks ago", "in 1 month", "1 year ago"
+ * - month-day without year: "March 5th" (resolved to next occurrence)
+ *
+ * For ambiguous "next Tuesday"-on-a-Tuesday — i.e. today is the named
+ * weekday — "next Tuesday" means 7 days from now (strictly future), not
+ * today. See README "parseRelative" for the documented behavior of each
+ * ambiguous case.
+ *
+ * Returns a Temporal.PlainDate for every supported phrase. (Time-of-day
+ * extensions like "next Tuesday at 3pm" aren't supported in this pass —
+ * the return type is always PlainDate.)
+ *
+ * Throws a descriptive error for any phrase it doesn't recognize, rather
+ * than guessing.
+ */
+export declare function parseRelative(input: string, referenceDate: unknown, options?: ParseRelativeOptions): unknown;

package/dist/parseRelative.d.ts

@@ -0,0 +1,25 @@
+import { type FormatOptions } from './tokens.js';
+export interface ParseRelativeOptions extends FormatOptions {
+}
+/**
+ * Resolve common English relative-date phrases against a reference date,
+ * returning a Temporal.PlainDate. Supported phrases (English only):
+ *
+ * - weekday refs: "next Tuesday", "last Friday", "this Monday"
+ * - day offsets: "today", "tomorrow", "yesterday"
+ * - unit offsets: "in 3 days", "2 weeks ago", "in 1 month", "1 year ago"
+ * - month-day without year: "March 5th" (resolved to next occurrence)
+ *
+ * For ambiguous "next Tuesday"-on-a-Tuesday — i.e. today is the named
+ * weekday — "next Tuesday" means 7 days from now (strictly future), not
+ * today. See README "parseRelative" for the documented behavior of each
+ * ambiguous case.
+ *
+ * Returns a Temporal.PlainDate for every supported phrase. (Time-of-day
+ * extensions like "next Tuesday at 3pm" aren't supported in this pass —
+ * the return type is always PlainDate.)
+ *
+ * Throws a descriptive error for any phrase it doesn't recognize, rather
+ * than guessing.
+ */
+export declare function parseRelative(input: string, referenceDate: unknown, options?: ParseRelativeOptions): unknown;

package/dist/temporalProvider.d.cts

@@ -2,6 +2,7 @@ interface TemporalFactory {
     from(fields: Record<string, number | string | undefined>, options?: {
         overflow?: 'constrain' | 'reject';
     }): unknown;
+    compare?(one: unknown, two: unknown): number;
 }
 export interface TemporalNamespace {
     PlainDate: TemporalFactory;

package/dist/temporalProvider.d.ts

@@ -2,6 +2,7 @@ interface TemporalFactory {
     from(fields: Record<string, number | string | undefined>, options?: {
         overflow?: 'constrain' | 'reject';
     }): unknown;
+    compare?(one: unknown, two: unknown): number;
 }
 export interface TemporalNamespace {
     PlainDate: TemporalFactory;

package/dist/tokens.d.cts

@@ -16,6 +16,13 @@ export interface TemporalLike {
 export interface FormatOptions {
     /** BCP 47 locale tag, e.g. 'en-US', 'fr-FR', 'ar-EG'. Defaults to 'en-US'. */
     locale?: string;
+    /**
+     * When set on parse(), opts into the lenient split heuristic for ambiguous
+     * glued numeric runs (e.g. "121" against "Md"). Default (false) keeps
+     * parse()'s strict behavior — throw on ambiguity rather than guess.
+     * See README "Lenient parse mode" for the heuristic and why it's opt-in.
+     */
+    lenient?: boolean;
 }
 export declare const DEFAULT_LOCALE = "en-US";
 type TokenHandler = (t: TemporalLike, locale: string) => string;

package/dist/tokens.d.ts

@@ -16,6 +16,13 @@ export interface TemporalLike {
 export interface FormatOptions {
     /** BCP 47 locale tag, e.g. 'en-US', 'fr-FR', 'ar-EG'. Defaults to 'en-US'. */
     locale?: string;
+    /**
+     * When set on parse(), opts into the lenient split heuristic for ambiguous
+     * glued numeric runs (e.g. "121" against "Md"). Default (false) keeps
+     * parse()'s strict behavior — throw on ambiguity rather than guess.
+     * See README "Lenient parse mode" for the heuristic and why it's opt-in.
+     */
+    lenient?: boolean;
 }
 export declare const DEFAULT_LOCALE = "en-US";
 type TokenHandler = (t: TemporalLike, locale: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "temporal-fmt",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "description": "Format Temporal.PlainDate/PlainDateTime/PlainTime/ZonedDateTime objects using date-fns-style token strings.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -25,12 +25,13 @@
   "scripts": {
     "build": "tsup && tsc --declaration --emitDeclarationOnly && node scripts/emit-cjs-types.mjs",
     "dev": "tsup --watch",
-    "test": "node --test test/*.test.js test/*.test.cjs",
+    "test": "node scripts/run-tests.mjs",
     "test:unit": "vitest run",
     "test:unit:watch": "vitest",
+    "test:coverage": "c8 --include=\"dist/index.js\" --include=\"dist/index.cjs\" --check-coverage --lines 90 --branches 75 --functions 88 -r text node scripts/run-tests.mjs",
     "test:types": "vitest run --typecheck",
-    "test:pack": "attw --pack .",
-    "test:all": "npm run build && npm test && npm run test:unit && npm run test:types && npm run test:pack",
+    "test:pack": "attw --pack . && publint .",
+    "test:all": "npm run build && npm test && npm run test:coverage && npm run test:unit && npm run test:types && npm run test:pack",
     "prepublishOnly": "npm run build && npm test"
   },
   "keywords": [
@@ -55,10 +56,12 @@
   "homepage": "https://github.com/DirazCoder/temporal-fmt#readme",
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
+    "c8": "^12.0.0",
+    "publint": "^0.3.23",
     "temporal-polyfill": "^1.0.4",
     "tsup": "^8.5.1",
     "typescript": "^7.0.2",
-    "vitest": "^4.1.10"
+    "vitest": "^4.1.11"
   },
   "overrides": {
     "esbuild": "0.28.1"