@checkdigit/time 3.0.0-PR.17-5aaf → 4.0.0-PR.18-81a3

package/src/date-fns/locale/_lib/buildLocalizeFn/index.ts

@@ -1,13 +1,80 @@
-import type { Era, Quarter, Month, Day } from '../../../types';
-import type { LocaleDayPeriod, LocalePatternWidth, LocaleUnit, LocalizeFn, LocalizeUnitIndex } from '../../types';
+/* eslint-disable no-unused-vars */
 
-type LocalizeEraValues = readonly [string, string];
+import type { Day, Era, Month, Quarter } from '../../../types';
+import type { LocaleDayPeriod, LocaleUnitValue, LocaleWidth, LocalizeFn } from '../../types';
 
-type LocalizeQuarterValues = readonly [string, string, string, string];
+export type BuildLocalizeFnArgs<
+  Value extends LocaleUnitValue,
+  ArgCallback extends LocalizeFnArgCallback<Value> | undefined,
+> = {
+  values: LocalizePeriodValuesMap<Value>;
+  defaultWidth: LocaleWidth;
+  formattingValues?: LocalizePeriodValuesMap<Value>;
+  defaultFormattingWidth?: LocaleWidth;
+} & (ArgCallback extends undefined
+  ? { argumentCallback?: undefined }
+  : { argumentCallback: LocalizeFnArgCallback<Value> });
+
+/**
+ * The localize function argument callback which allows to convert raw value to
+ * the actual type.
+ *
+ * @param value - The value to convert
+ *
+ * @returns The converted value
+ */
+export type LocalizeFnArgCallback<Value extends LocaleUnitValue | number> = (value: Value) => LocalizeUnitIndex<Value>;
+
+/**
+ * The map of localized values for each width.
+ */
+export type LocalizePeriodValuesMap<Value extends LocaleUnitValue> = {
+  [Pattern in LocaleWidth]?: LocalizeValues<Value>;
+};
+
+/**
+ * The index type of the locale unit value. It types conversion of units of
+ * values that don't start at 0 (i.e. quarters).
+ */
+export type LocalizeUnitIndex<Value extends LocaleUnitValue | number> = Value extends LocaleUnitValue
+  ? keyof LocalizeValues<Value>
+  : number;
+
+/**
+ * Converts the unit value to the tuple of values.
+ */
+export type LocalizeValues<Value extends LocaleUnitValue> = Value extends LocaleDayPeriod
+  ? Record<LocaleDayPeriod, string>
+  : Value extends Era
+    ? LocalizeEraValues
+    : Value extends Quarter
+      ? LocalizeQuarterValues
+      : Value extends Day
+        ? LocalizeDayValues
+        : Value extends Month
+          ? LocalizeMonthValues
+          : never;
+
+/**
+ * The tuple of localized era values. The first element represents BC,
+ * the second element represents AD.
+ */
+export type LocalizeEraValues = readonly [string, string];
+
+/**
+ * The tuple of localized quarter values. The first element represents Q1.
+ */
+export type LocalizeQuarterValues = readonly [string, string, string, string];
 
-type LocalizeDayValues = readonly [string, string, string, string, string, string, string];
+/**
+ * The tuple of localized day values. The first element represents Sunday.
+ */
+export type LocalizeDayValues = readonly [string, string, string, string, string, string, string];
 
-type LocalizeMonthValues = readonly [
+/**
+ * The tuple of localized month values. The first element represents January.
+ */
+export type LocalizeMonthValues = readonly [
   string,
   string,
   string,
@@ -22,76 +89,25 @@ type LocalizeMonthValues = readonly [
   string,
 ];
 
-export type LocalizeUnitValuesIndex<Values extends LocalizeUnitValues<any>> = Values extends Record<
-  LocaleDayPeriod,
-  string
->
-  ? string
-  : Values extends LocalizeEraValues
-  ? Era
-  : Values extends LocalizeQuarterValues
-  ? Quarter
-  : Values extends LocalizeDayValues
-  ? Day
-  : Values extends LocalizeMonthValues
-  ? Month
-  : never;
-
-export type LocalizeUnitValues<Unit extends LocaleUnit> = Unit extends LocaleDayPeriod
-  ? Record<LocaleDayPeriod, string>
-  : Unit extends Era
-  ? LocalizeEraValues
-  : Unit extends Quarter
-  ? LocalizeQuarterValues
-  : Unit extends Day
-  ? LocalizeDayValues
-  : Unit extends Month
-  ? LocalizeMonthValues
-  : never;
-
-export type LocalizePeriodValuesMap<Unit extends LocaleUnit> = {
-  [pattern in LocalePatternWidth]?: LocalizeUnitValues<Unit>;
-};
-
-export type BuildLocalizeFnArgCallback<Result extends LocaleUnit | number> = (
-  value: Result,
-) => LocalizeUnitIndex<Result>;
-
-export type BuildLocalizeFnArgs<
-  Result extends LocaleUnit,
-  ArgCallback extends BuildLocalizeFnArgCallback<Result> | undefined,
-> = {
-  values: LocalizePeriodValuesMap<Result>;
-  defaultWidth: LocalePatternWidth;
-  formattingValues?: LocalizePeriodValuesMap<Result>;
-  defaultFormattingWidth?: LocalePatternWidth;
-} & (ArgCallback extends undefined
-  ? { argumentCallback?: undefined }
-  : { argumentCallback: BuildLocalizeFnArgCallback<Result> });
-
-export default function buildLocalizeFn<
-  Result extends LocaleUnit,
-  ArgCallback extends BuildLocalizeFnArgCallback<Result> | undefined,
->(args: BuildLocalizeFnArgs<Result, ArgCallback>): LocalizeFn<Result, ArgCallback> {
-  return (dirtyIndex, options) => {
+export function buildLocalizeFn<
+  Value extends LocaleUnitValue,
+  ArgCallback extends LocalizeFnArgCallback<Value> | undefined,
+>(args: BuildLocalizeFnArgs<Value, ArgCallback>): LocalizeFn<Value> {
+  return (value, options) => {
     const context = options?.context ? String(options.context) : 'standalone';
 
-    let valuesArray: LocalizeUnitValues<Result>;
+    let valuesArray: LocalizeValues<Value>;
     if (context === 'formatting' && args.formattingValues) {
       const defaultWidth = args.defaultFormattingWidth || args.defaultWidth;
-      const width = (options?.width ? String(options.width) : defaultWidth) as LocalePatternWidth;
-      valuesArray = (args.formattingValues[width] || args.formattingValues[defaultWidth]) as LocalizeUnitValues<Result>;
+      const width = (options?.width ? String(options.width) : defaultWidth) as LocaleWidth;
+      valuesArray = (args.formattingValues[width] || args.formattingValues[defaultWidth]) as LocalizeValues<Value>;
     } else {
       const defaultWidth = args.defaultWidth;
-      const width = (options?.width ? String(options.width) : args.defaultWidth) as LocalePatternWidth;
-      valuesArray = (args.values[width] || args.values[defaultWidth]) as LocalizeUnitValues<Result>;
+      const width = (options?.width ? String(options.width) : args.defaultWidth) as LocaleWidth;
+      valuesArray = (args.values[width] || args.values[defaultWidth]) as LocalizeValues<Value>;
     }
-    const index = (
-      args.argumentCallback
-        ? args.argumentCallback(dirtyIndex as Result)
-        : (dirtyIndex as LocalizeUnitIndex<Result> as unknown)
-    ) as LocalizeUnitValuesIndex<typeof valuesArray>;
-    // @ts-ignore: For some reason TypeScript just don't want to match it, no matter how hard we try. I challenge you to try to remove it!
+    const index = (args.argumentCallback ? args.argumentCallback(value as Value) : value) as LocalizeUnitIndex<Value>;
+    // @ts-expect-error - For some reason TypeScript just don't want to match it, no matter how hard we try. I challenge you to try to remove it!
     return valuesArray[index];
   };
 }

package/src/date-fns/locale/_lib/buildMatchFn/index.ts

@@ -1,10 +1,47 @@
-import type { BuildMatchFnArgs, LocaleDayPeriod, LocaleUnit, LocalePatternWidth, MatchFn } from '../../types';
+import type { Quarter, Era, Day, Month } from '../../../types';
+import type { LocaleUnitValue, LocaleWidth, LocaleDayPeriod, MatchFn, MatchValueCallback } from '../../types';
 
-export default function buildMatchFn<
-  Result extends LocaleUnit,
-  DefaultMatchWidth extends LocalePatternWidth,
-  DefaultParseWidth extends LocalePatternWidth,
->(args: BuildMatchFnArgs<Result, DefaultMatchWidth, DefaultParseWidth>): MatchFn<Result> {
+export interface BuildMatchFnArgs<
+  Result extends LocaleUnitValue,
+  DefaultMatchWidth extends LocaleWidth,
+  DefaultParseWidth extends LocaleWidth,
+> {
+  matchPatterns: BuildMatchFnMatchPatterns<DefaultMatchWidth>;
+  defaultMatchWidth: DefaultMatchWidth;
+  parsePatterns: BuildMatchFnParsePatterns<Result, DefaultParseWidth>;
+  defaultParseWidth: DefaultParseWidth;
+  valueCallback?: MatchValueCallback<Result extends LocaleDayPeriod ? string : number, Result>;
+}
+
+export type BuildMatchFnMatchPatterns<DefaultWidth extends LocaleWidth> = {
+  [Width in LocaleWidth]?: RegExp;
+} & {
+  [Width in DefaultWidth]: RegExp;
+};
+
+export type BuildMatchFnParsePatterns<Value extends LocaleUnitValue, DefaultWidth extends LocaleWidth> = {
+  [Width in LocaleWidth]?: ParsePattern<Value>;
+} & {
+  [Width in DefaultWidth]: ParsePattern<Value>;
+};
+
+export type ParsePattern<Value extends LocaleUnitValue> = Value extends LocaleDayPeriod
+  ? Record<LocaleDayPeriod, RegExp>
+  : Value extends Quarter
+    ? readonly [RegExp, RegExp, RegExp, RegExp]
+    : Value extends Era
+      ? readonly [RegExp, RegExp]
+      : Value extends Day
+        ? readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp]
+        : Value extends Month
+          ? readonly [RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp, RegExp]
+          : never;
+
+export function buildMatchFn<
+  Value extends LocaleUnitValue,
+  DefaultMatchWidth extends LocaleWidth,
+  DefaultParseWidth extends LocaleWidth,
+>(args: BuildMatchFnArgs<Value, DefaultMatchWidth, DefaultParseWidth>): MatchFn<Value> {
   return (string, options = {}) => {
     const width = options.width;
 
@@ -21,15 +58,19 @@ export default function buildMatchFn<
     const key = (
       Array.isArray(parsePatterns)
         ? findIndex(parsePatterns, (pattern) => pattern.test(matchedString))
-        : findKey(parsePatterns, (pattern: any) => pattern.test(matchedString))
-    ) as Result extends LocaleDayPeriod ? string : number;
+        : // eslint-disable-next-line @typescript-eslint/no-explicit-any -- I challange you to fix the type
+          findKey(parsePatterns, (pattern: any) => pattern.test(matchedString))
+    ) as Value extends LocaleDayPeriod ? string : number;
 
-    let value: Result;
+    let value: Value;
 
-    value = (args.valueCallback ? args.valueCallback(key) : key) as Result;
-    value = options.valueCallback ? options.valueCallback(value as any) : value;
+    value = (args.valueCallback ? args.valueCallback(key) : key) as Value;
+    value = options.valueCallback
+      ? // eslint-disable-next-line @typescript-eslint/no-explicit-any -- I challange you to fix the type
+        options.valueCallback(value as any)
+      : value;
 
-    const rest = string.slice((matchedString as string).length);
+    const rest = string.slice(matchedString.length);
 
     return { value, rest };
   };
@@ -40,7 +81,7 @@ function findKey<Value, Obj extends { [key in string | number]: Value }>(
   predicate: (value: Value) => boolean,
 ): keyof Obj | undefined {
   for (const key in object) {
-    if (object.hasOwnProperty(key) && predicate(object[key] as Value)) {
+    if (Object.prototype.hasOwnProperty.call(object, key) && predicate(object[key]!)) {
       return key;
     }
   }
@@ -49,7 +90,7 @@ function findKey<Value, Obj extends { [key in string | number]: Value }>(
 
 function findIndex<Item>(array: Item[], predicate: (item: Item) => boolean): number | undefined {
   for (let key = 0; key < array.length; key++) {
-    if (predicate(array[key] as Item)) {
+    if (predicate(array[key]!)) {
       return key;
     }
   }

package/src/date-fns/locale/_lib/buildMatchPatternFn/index.ts

@@ -6,7 +6,7 @@ export interface BuildMatchPatternFnArgs<Result> {
   valueCallback?: MatchValueCallback<string, Result>;
 }
 
-export default function buildMatchPatternFn<Result>(args: BuildMatchPatternFnArgs<Result>): MatchFn<Result> {
+export function buildMatchPatternFn<Result>(args: BuildMatchPatternFnArgs<Result>): MatchFn<Result> {
   return (string, options = {}) => {
     const matchResult = string.match(args.matchPattern);
     if (!matchResult) return null;
@@ -14,10 +14,11 @@ export default function buildMatchPatternFn<Result>(args: BuildMatchPatternFnArg
 
     const parseResult = string.match(args.parsePattern);
     if (!parseResult) return null;
-    let value = (args.valueCallback ? args.valueCallback(parseResult[0] as string) : parseResult[0]) as Result;
+    let value = (args.valueCallback ? args.valueCallback(parseResult[0]) : parseResult[0]) as Result;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- I challange you to fix the type
     value = options.valueCallback ? options.valueCallback(value as any) : value;
 
-    const rest = string.slice((matchedString as string).length);
+    const rest = string.slice(matchedString.length);
 
     return { value, rest };
   };

package/src/date-fns/locale/en-US/_lib/formatDistance/index.ts

@@ -86,7 +86,7 @@ const formatDistanceLocale: FormatDistanceLocale<FormatDistanceTokenValue> = {
   },
 };
 
-const formatDistance: FormatDistanceFn = (token, count, options) => {
+export const formatDistance: FormatDistanceFn = (token, count, options) => {
   let result;
 
   const tokenValue = formatDistanceLocale[token];
@@ -108,5 +108,3 @@ const formatDistance: FormatDistanceFn = (token, count, options) => {
 
   return result;
 };
-
-export default formatDistance;

package/src/date-fns/locale/en-US/_lib/formatLong/index.ts

@@ -1,4 +1,4 @@
-import buildFormatLongFn from '../../../_lib/buildFormatLongFn/index';
+import { buildFormatLongFn } from '../../../_lib/buildFormatLongFn/index';
 import type { FormatLong } from '../../../types';
 
 const dateFormats = {
@@ -22,7 +22,7 @@ const dateTimeFormats = {
   short: '{{date}}, {{time}}',
 };
 
-const formatLong: FormatLong = {
+export const formatLong: FormatLong = {
   date: buildFormatLongFn({
     formats: dateFormats,
     defaultWidth: 'full',
@@ -38,5 +38,3 @@ const formatLong: FormatLong = {
     defaultWidth: 'full',
   }),
 };
-
-export default formatLong;

package/src/date-fns/locale/en-US/_lib/formatRelative/index.ts

@@ -9,6 +9,4 @@ const formatRelativeLocale = {
   other: 'P',
 };
 
-const formatRelative: FormatRelativeFn = (token, _date, _baseDate, _options) => formatRelativeLocale[token];
-
-export default formatRelative;
+export const formatRelative: FormatRelativeFn = (token, _date, _baseDate, _options) => formatRelativeLocale[token];

package/src/date-fns/locale/en-US/_lib/localize/index.ts

@@ -1,6 +1,5 @@
-import type { Quarter } from '../../../../types';
 import type { Localize, LocalizeFn } from '../../../types';
-import buildLocalizeFn from '../../../_lib/buildLocalizeFn/index';
+import { buildLocalizeFn } from '../../../_lib/buildLocalizeFn/index';
 
 const eraValues = {
   narrow: ['B', 'A'] as const,
@@ -110,7 +109,7 @@ const formattingDayPeriodValues = {
   },
 };
 
-const ordinalNumber: LocalizeFn<number, undefined> = (dirtyNumber, _options) => {
+const ordinalNumber: LocalizeFn<number> = (dirtyNumber, _options) => {
   const number = Number(dirtyNumber);
 
   // If ordinal numbers depend on context, for example,
@@ -134,7 +133,7 @@ const ordinalNumber: LocalizeFn<number, undefined> = (dirtyNumber, _options) =>
   return number + 'th';
 };
 
-const localize: Localize = {
+export const localize: Localize = {
   ordinalNumber,
 
   era: buildLocalizeFn({
@@ -145,7 +144,7 @@ const localize: Localize = {
   quarter: buildLocalizeFn({
     values: quarterValues,
     defaultWidth: 'wide',
-    argumentCallback: (quarter) => (quarter - 1) as Quarter,
+    argumentCallback: (quarter) => quarter - 1,
   }),
 
   month: buildLocalizeFn({
@@ -165,5 +164,3 @@ const localize: Localize = {
     defaultFormattingWidth: 'wide',
   }),
 };
-
-export default localize;

package/src/date-fns/locale/en-US/_lib/match/index.ts

@@ -1,7 +1,7 @@
 import type { Quarter } from '../../../../types';
 import type { Match } from '../../../types';
-import buildMatchFn from '../../../_lib/buildMatchFn/index';
-import buildMatchPatternFn from '../../../_lib/buildMatchPatternFn/index';
+import { buildMatchFn } from '../../../_lib/buildMatchFn/index';
+import { buildMatchPatternFn } from '../../../_lib/buildMatchPatternFn/index';
 
 const matchOrdinalNumberPattern = /^(\d+)(th|st|nd|rd)?/i;
 const parseOrdinalNumberPattern = /\d+/i;
@@ -62,7 +62,7 @@ const parseDayPeriodPatterns = {
   },
 };
 
-const match: Match = {
+export const match: Match = {
   ordinalNumber: buildMatchPatternFn({
     matchPattern: matchOrdinalNumberPattern,
     parsePattern: parseOrdinalNumberPattern,
@@ -105,5 +105,3 @@ const match: Match = {
     defaultParseWidth: 'any',
   }),
 };
-
-export default match;

package/src/date-fns/locale/en-US/index.ts

@@ -1,20 +1,19 @@
-import formatDistance from './_lib/formatDistance/index';
-import formatLong from './_lib/formatLong/index';
-import formatRelative from './_lib/formatRelative/index';
-import localize from './_lib/localize/index';
-import match from './_lib/match/index';
+import { formatDistance } from './_lib/formatDistance/index';
+import { formatLong } from './_lib/formatLong/index';
+import { formatRelative } from './_lib/formatRelative/index';
+import { localize } from './_lib/localize/index';
+import { match } from './_lib/match/index';
 import type { Locale } from '../types';
 
 /**
- * @type {Locale}
  * @category Locales
  * @summary English locale (United States).
  * @language English
  * @iso-639-2 eng
- * @author Sasha Koss [@kossnocorp]{@link https://github.com/kossnocorp}
- * @author Lesha Koss [@leshakoss]{@link https://github.com/leshakoss}
+ * @author Sasha Koss [@kossnocorp](https://github.com/kossnocorp)
+ * @author Lesha Koss [@leshakoss](https://github.com/leshakoss)
  */
-const locale: Locale = {
+export const enUS: Locale = {
   code: 'en-US',
   formatDistance: formatDistance,
   formatLong: formatLong,
@@ -26,5 +25,3 @@ const locale: Locale = {
     firstWeekContainsDate: 1,
   },
 };
-
-export default locale;