atomic-fns 0.3.3 → 0.3.4

package/core/i18n/date/format.ts

@@ -0,0 +1,343 @@
+const NATIVE_DATE =
+  /^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/
+
+/**
+ * Returns a new Date from the given arguments.
+ * @param {string | number | Date} date The date value
+ * @param {?boolean} [utc=false] Interprets the given value as a UTC date
+ * @returns {Date} The new date object
+ */
+export function getDate(date: string | number | Date, utc = false) {
+  if (date === null) return new Date(NaN)
+  if (!date) return new Date()
+  if (date instanceof Date) return new Date(date)
+  if (typeof date === 'string' && !/Z$/i.test(date)) {
+    const d = date.match(NATIVE_DATE) as any
+    if (d) {
+      const m = d[2] - 1 || 0
+      const ms = (d[7] || '0').slice(0, 3)
+      if (utc) {
+        return new Date(Date.UTC(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms))
+      }
+      return new Date(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms)
+    }
+  }
+  return new Date(date)
+}
+
+const n = 'numeric',
+  s = 'short',
+  l = 'long',
+  dd = '2-digit',
+  TOKEN_MAP = {
+    // weekday
+    '%A': { weekday: l },
+    '%a': { weekday: s },
+    '%aa': { weekday: n },
+    // day
+    '%d': { day: dd },
+    '%-d': { day: n },
+    // month
+    '%m': { month: dd },
+    '%-m': { month: n },
+    '%B': { month: l },
+    '%b': { month: s },
+    '%bb': { month: n },
+    // year
+    '%y': { year: n },
+    '%Y': { year: dd },
+    // hour
+    '%K': { hourCycle: 'h11', hour: dd },
+    '%I': { hourCycle: 'h12', hour: dd },
+    '%-I': { hourCycle: 'h12', hour: n },
+    '%H': { hourCycle: 'h23', hour: dd },
+    '%-H': { hourCycle: 'h23', hour: n },
+    '%k': { hourCycle: 'h24', hour: n },
+    // minutes
+    '%M': { minute: dd },
+    '%-M': { minute: n },
+    // seconds
+    '%S': { second: dd },
+    '%-S': { second: n },
+    // day period
+    '%P': { dayPeriod: l },
+    '%p': { dayPeriod: s },
+    '%pp': { dayPeriod: 'narrow' },
+    // era
+    '%N': { era: l, year: dd },
+    '%n': { era: s, year: dd },
+    '%nn': { era: n, year: 'narrow' },
+    // timeZoneName
+    '%Z': { timeZoneName: 'longGeneric', year: dd },
+    '%-Z': { timeZoneName: 'shortGeneric', year: dd },
+    '%z': { timeZoneName: 'longOffset', year: dd },
+    '%-z': { timeZoneName: 'shortOffset', year: dd },
+    '%ZZ': { timeZoneName: l, year: dd },
+    '%-ZZ': { timeZoneName: s, year: dd }
+  }
+
+const HOUR_PARTS = { '%I': 1, '%-I': 1, '%K': 1, '%k': 1 }
+const ERA_PARTS = { '%n': 1, '%N': 1, '%nn': 1 }
+const TZ_PARTS = { '%ZZ': 1, '%-ZZ': 1, '%-z': 1, '%z': 1, '%-Z': 1, '%Z': 1 }
+
+const formatter = (locale: string, opts) => new Intl.DateTimeFormat(locale, opts)
+
+/**
+ * Formats a date using a formatting string in the {@link https://strftime.org/ strftime} format, in any given locale.
+ * @param {string} fmt The format string to apply
+ * @param {number | Date} date The date value
+ * @param {?string} locale The locale to use when formatting (default is system locale).
+ * @returns {string} The string representation of date
+ * @see {@link https://strftime.org/ strftime format}
+ */
+export function format(fmt: string, date: number | Date, locale?) {
+  let results: string[] = [],
+    dayPeriod: string = '',
+    dayPeriodIndex = -1
+  for (let i = 0; i < fmt.length; i++) {
+    let part = fmt[i]
+    if (part === '%') {
+      // check for escaped '%'
+      if (fmt[++i] == '%') {
+        results.push('%')
+        continue
+      }
+
+      if (fmt[i] === '-') {
+        part += fmt[i++]
+      }
+
+      part += fmt[i]
+      // add any repeated characters that come after
+      while (i < fmt.length - 1 && fmt[i + 1] === fmt[i]) part += fmt[++i]
+
+      if (HOUR_PARTS[part]) {
+        let res = formatter(locale, TOKEN_MAP[part]).format(date).split(' ')
+        // save the AM/PM for the correct spot
+        results.push(res[0])
+        dayPeriod = res[1]
+        continue
+      }
+
+      if (part === '%P' || part === '%p') {
+        // leave this flag in place for later
+        dayPeriodIndex = results.length
+        results.push(part)
+        continue
+      }
+
+      if (ERA_PARTS[part] || TZ_PARTS[part]) {
+        // the formatting includes the date/year so we take what comes after
+        let res = formatter(locale, TOKEN_MAP[part]).format(date).split(' ')
+        results.push(res.slice(1).join(' '))
+        continue
+      }
+
+      // format any other parts
+      let res = formatter(locale, TOKEN_MAP[part]).format(date)
+      if (part === '%S' && res.length === 1) res = '0' + res
+      results.push(res)
+    } else {
+      // output as literal
+      results.push(part)
+    }
+  }
+
+  // insert the AM/PM at the correct spot
+  if (dayPeriodIndex >= 0) results[dayPeriodIndex] = dayPeriod || ''
+
+  return results.join('')
+}
+
+const DATETIME_DEFAULT = {}
+
+/** 10/14/1983 */
+const DATE_SHORT = {
+  year: n,
+  month: n,
+  day: n
+}
+
+/** Oct 14, 1983 */
+const DATE_MED = {
+  year: n,
+  month: s,
+  day: n
+}
+
+/** Fri, Oct 14, 1983 */
+const DATE_MED_WITH_WEEKDAY = {
+  year: n,
+  month: s,
+  day: n,
+  weekday: s
+}
+
+/** October 14, 1983 */
+const DATE_FULL = {
+  year: n,
+  month: l,
+  day: n
+}
+
+/** Tuesday, October 14, 1983 */
+const DATE_HUGE = {
+  year: n,
+  month: l,
+  day: n,
+  weekday: l
+}
+
+/** 09:30 AM */
+const TIME_SIMPLE = {
+  hour: n,
+  minute: n
+}
+
+/** 09:30:23 AM */
+const TIME_WITH_SECONDS = {
+  hour: n,
+  minute: n,
+  second: n
+}
+
+/** 09:30:23 AM EDT */
+const TIME_WITH_SHORT_OFFSET = {
+  hour: n,
+  minute: n,
+  second: n,
+  timeZoneName: s
+}
+
+/** 09:30:23 AM Eastern Daylight Time */
+const TIME_WITH_LONG_OFFSET = {
+  hour: n,
+  minute: n,
+  second: n,
+  timeZoneName: l
+}
+
+/** 09:30 */
+const TIME_24_SIMPLE = {
+  hour: n,
+  minute: n,
+  hourCycle: 'h23'
+}
+
+/** 09:30:23 */
+const TIME_24_WITH_SECONDS = {
+  hour: n,
+  minute: n,
+  second: n,
+  hourCycle: 'h23'
+}
+
+/** 09:30:23 EDT */
+const TIME_24_WITH_SHORT_OFFSET = {
+  hour: n,
+  minute: n,
+  second: n,
+  hourCycle: 'h23',
+  timeZoneName: s
+}
+
+/** 09:30:23 Eastern Daylight Time */
+const TIME_24_WITH_LONG_OFFSET = {
+  hour: n,
+  minute: n,
+  second: n,
+  hourCycle: 'h23',
+  timeZoneName: l
+}
+
+/** 10/14/1983, 9:30 AM */
+const DATETIME_SHORT = {
+  year: n,
+  month: n,
+  day: n,
+  hour: n,
+  minute: n
+}
+
+/** 10/14/1983, 9:30:33 AM */
+const DATETIME_SHORT_WITH_SECONDS = {
+  year: n,
+  month: n,
+  day: n,
+  hour: n,
+  minute: n,
+  second: n
+}
+
+/** Oct 14, 1983, 9:30 AM */
+const DATETIME_MED = {
+  year: n,
+  month: s,
+  day: n,
+  hour: n,
+  minute: n
+}
+
+/** Oct 14, 1983, 9:30:33 AM */
+const DATETIME_MED_WITH_SECONDS = {
+  year: n,
+  month: s,
+  day: n,
+  hour: n,
+  minute: n,
+  second: n
+}
+
+/** Fri, 14 Oct 1983, 9:30 AM */
+const DATETIME_MED_WITH_WEEKDAY = {
+  year: n,
+  month: s,
+  day: n,
+  weekday: s,
+  hour: n,
+  minute: n
+}
+
+/** October 14, 1983, 9:30 AM EDT */
+const DATETIME_FULL = {
+  year: n,
+  month: l,
+  day: n,
+  hour: n,
+  minute: n,
+  timeZoneName: s
+}
+
+/** October 14, 1983, 9:30:33 AM EDT */
+const DATETIME_FULL_WITH_SECONDS = {
+  year: n,
+  month: l,
+  day: n,
+  hour: n,
+  minute: n,
+  second: n,
+  timeZoneName: s
+}
+
+/** Friday, October 14, 1983, 9:30 AM Eastern Daylight Time */
+const DATETIME_HUGE = {
+  year: n,
+  month: l,
+  day: n,
+  weekday: l,
+  hour: n,
+  minute: n,
+  timeZoneName: l
+}
+
+/** Friday, October 14, 1983, 9:30:33 AM Eastern Daylight Time */
+const DATETIME_HUGE_WITH_SECONDS = {
+  year: n,
+  month: l,
+  day: n,
+  weekday: l,
+  hour: n,
+  minute: n,
+  second: n,
+  timeZoneName: l
+}

package/core/i18n/date/index.d.ts

@@ -0,0 +1,223 @@
+export declare type DateParts = {
+    year?: number;
+    month?: number;
+    day?: number;
+    hour?: number;
+    minute?: number;
+    second?: number;
+    millisecond?: number;
+};
+export declare type DateLike = number | string | Date | DateParts;
+/**
+ * Creates a date tied to a given locale (default system locale) which can be formatted in that locale's language using the native {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl Intl Apis} directly or using a formatting string compatible with `strftime`.
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl Intl Apis}
+ * @see {@link https://strftime.org/ strftime format}
+ */
+export declare class IntlDate {
+    private self;
+    readonly year: number;
+    readonly M: number;
+    readonly day: number;
+    readonly weekDay: number;
+    readonly hour: number;
+    readonly minute: number;
+    readonly second: number;
+    readonly millisecond: number;
+    readonly locale: string;
+    /** Returns the current UTC date and time. */
+    static UTC(obj?: DateLike): IntlDate;
+    /** Returns the current local date and time.*/
+    static now(): IntlDate;
+    /**
+     * Creates a new `IntlDate` tied to the specified locale (default is system locale).
+     * **Note:** The allowed values for `month` start at 1, which is different from legacy `Date`
+     * @param {DateLike | IntlDate} obj The date value (default is now)
+     * @param {{locale?: string, utc?: boolean}} opts
+     * @returns
+     */
+    constructor(obj?: DateLike | IntlDate, { locale, utc }?: any);
+    isValid(): boolean;
+    /** Get the this date's month as a number from 1-12. */
+    get month(): number;
+    /** Get the number of days in this date's month. */
+    daysInMonth(): number | null;
+    /** Get the number of days in this date's year. */
+    daysInYear(): 366 | 365;
+    /** Returns `true` if this date's year is a leap year, otherwise `false`. */
+    isLeapYear(): boolean;
+    /** Gets the number of weeks according to locale in the current moment's year. */
+    weeksInYear(): 53 | 52;
+    /**
+     * Returns a localized string representation of this date.
+     * @param {Intl.DateTimeFormatOptions} opts The options to use for the format
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat Intl.DateTimeFormat()}
+     */
+    toString(opts?: Intl.DateTimeFormatOptions): string;
+    /**
+     * Returns a localized string representation of this date, according to the given format string. Format codes use the same specification as C / Python's strftime().
+     * @param {string} str The format string to use
+     * @see {@link https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes Format Codes}
+     * @example
+  ```js
+  new IntlDate().format('%m/%d/%y') // '10/31/2022'
+  ```
+     */
+    format(str: string): string;
+    /**
+     * Returns a new copy of the native `Date` object used by this instance.
+     * @returns {Date} A new `Date` object
+     */
+    toDate(): Date;
+    /**
+     * Returns the timestamp representing the UTC equivalent of this date.
+     * @returns {number} The UTC timestamp of this date.
+     */
+    toUTC(): number;
+    /**
+     * Returns the number of seconds since the Unix Epoch (January 1, 1970 UTC).
+     * @see {@link IntlDate.timestamp}
+     * @see {@link IntlDate.unix}
+     * @example
+  ```js
+  new IntlDate().toSeconds() // 1318874398
+  ```
+     */
+    toSeconds(): number;
+    /**
+     * Returns the number of seconds since the Unix Epoch (January 1, 1970 UTC).
+     * @see {@link IntlDate.toSeconds}
+     * @see {@link IntlDate.unix}
+     * @example
+  ```js
+  new IntlDate().timestamp() // 1318874398
+  ```
+     */
+    timestamp(): number;
+    /**
+     * Returns the number of seconds since the Unix Epoch (January 1, 1970 UTC).
+     * @see {@link IntlDate.toSeconds}
+     * @see {@link IntlDate.timestamp}
+     * @example
+  ```js
+  new IntlDate().unix() // 1318874398
+  ```
+     */
+    unix(): number;
+    /** Formats a string to the ISO8601 standard.
+     * @example
+  ```js
+  new IntlDate().toISOString() // '2022-10-31T22:44:30.652Z'
+  ```
+     */
+    toISOString(): string;
+    /** Returns the date part formatted as ISO8601.
+     * @example
+  ```js
+  new IntlDate().toISODate() // '2022-10-31'
+  ```
+     */
+    toISODate(): string;
+    /** Returns the time part formatted as ISO8601.
+     * @example
+  ```js
+  new IntlDate().toISOTime() // 'T22:44:30.652Z'
+  ```
+     */
+    toISOTime(): string;
+    /**
+     * Returns an object containing year, month, day-of-month, hours, minutes, seconds, milliseconds.
+     * @returns {Object} An object like `{year, month, date, hours, minutes, seconds, ms}`
+     */
+    toObject(): DateParts;
+    /** Returns the number of milliseconds since the Unix Epoch (January 1, 1970 UTC)  */
+    valueOf(): number;
+    /** Returns the timezone string name  */
+    zoneName(): string;
+    /** Returns the timezone GMT offset name  */
+    offset(): string;
+    /**
+     * Check if this date is before another date. The other value will be parsed as an `IntlDate` if not already so.
+     * @param {string | number | Object | Date | IntlDate} other Another date or date like object
+     * @returns {boolean} Returns `true` if this date is before the given value
+     */
+    isBefore(other: DateLike | IntlDate): boolean;
+    /**
+     * Check if this date is strictly after the given `start` and before `stop` dates. The values will be parsed as an `IntlDate` if not already so.
+     * @param {string | number | Object | Date | IntlDate} start The smaller date
+     * @param {string | number | Object | Date | IntlDate} stop The larger date
+     * @returns {boolean} Returns `true` if this date is greater than `start` and less than `stop`.
+     */
+    isBetween(start: DateLike | IntlDate, stop: DateLike | IntlDate): boolean;
+    /**
+     * Check if this date is after another date. The other value will be parsed as an `IntlDate` if not already so.
+     * @param {string | number | DateParts | Date | IntlDate} other Another date or date like object
+     * @returns {boolean} Returns `true` if this date is after the given value
+     */
+    isAfter(other: DateLike | IntlDate): boolean;
+    /**
+     * Check if this date is the same as `other`.
+     * @param other Another date object
+     * @returns {boolean} Returns `true` if this date is the same as other
+     */
+    isSame(other: Date | IntlDate): boolean;
+    /**
+     * Returns the minimum (most distant past) of the given date values.
+     * @param {Array<Date | IntlDate>} dates
+     * @returns {Date | IntlDate} The smallest date of `dates`
+     * @see {@link minDate}
+     */
+    static min(...dates: Array<Date | IntlDate>): Date | IntlDate;
+    /**
+     * Returns the maximum (most distant future) of the given date values.
+     * @param {Array<Date | IntlDate>} dates
+     * @returns {Date | IntlDate} The largest date of `dates`
+     * @see {@link maxDate}
+     */
+    static max(...dates: Array<Date | IntlDate>): Date | IntlDate;
+    lt(other: Date | IntlDate): boolean;
+    eq(other: Date | IntlDate): boolean;
+    compare(other: Date | IntlDate): 0 | 1 | -1;
+}
+/**
+ * Converts the given date to a UTC timestamp.
+ * @param {Date} date
+ * @returns {number} The milliseconds between the specified date and the UTC Epoch date.
+ */
+export declare function dateToUTC(date: Date): number;
+/**
+ * Returns the minimum (most distant past) of the given date values.
+ * @param {Array<Date | IntlDate>} dates
+ * @returns {Date | IntlDate} The smallest date of `dates`
+ */
+export declare function minDate(...dates: Array<Date | IntlDate>): Date | IntlDate;
+/**
+ * Returns the maximum (most distant future) of the given date values.
+ * @param {Array<Date | IntlDate>} dates
+ * @returns {Date | IntlDate} The largest date of `dates`
+ */
+export declare function maxDate(...dates: Array<Date | IntlDate>): Date | IntlDate;
+/**
+ * Returns `true` if the year is a leap year, otherwise `false`.
+ * @param year The date year
+ * @returns {boolean} `true` if is a leap year
+ */
+export declare function isLeapYear(year: number): boolean;
+/**
+ * Get the number of days in the given year.
+ * @param year The date year
+ * @returns {number} Number of days in year
+ */
+export declare function daysInYear(year: number): 366 | 365;
+/**
+ * Get the number of days in the given month and year.
+ * @param year The date year
+ * @param month The date month
+ * @returns {number} Number of days in month
+ */
+export declare function daysInMonth(year: number, month: number): number | null;
+/**
+ * Gets the number of weeks according to locale in the current moment's year.
+ * @param {number} weekYear The the date year
+ * @returns {number}
+ */
+export declare function weeksInYear(weekYear: number): 53 | 52;