@naturalcycles/js-lib 15.83.0 → 15.84.1

package/src/datetime/localTime.ts

@@ -1,5 +1,6 @@
 import { comparators } from '../array/sort.js'
 import { _assert } from '../error/assert.js'
+import { Intl2 } from '../intl/intl.js'
 import type {
   IANATimezone,
   Inclusiveness,
@@ -108,15 +109,7 @@ export class LocalTime {
    * @experimental
    */
   inTimezone(tz: IANATimezone): WallTime {
-    const d = new Date(this.$date.toLocaleString('en-US', { timeZone: tz }))
-    return new WallTime({
-      year: d.getFullYear(),
-      month: d.getMonth() + 1,
-      day: d.getDate(),
-      hour: d.getHours(),
-      minute: d.getMinutes(),
-      second: d.getSeconds(),
-    })
+    return new WallTime(getWallComponentsInTimezone(this.$date, tz))
   }
 
   /**
@@ -136,8 +129,13 @@ export class LocalTime {
   getUTCOffsetMinutes(tz?: IANATimezone): NumberOfMinutes {
     if (tz) {
       // based on: https://stackoverflow.com/a/53652131/4919972
+      // The wall clock in `tz` is interpreted as UTC (not as host-local time, like the
+      // stackoverflow answer does): `wall = utc + offset`, so `offset = Date.UTC(wall) - now`.
+      // This makes the result independent of the host timezone (the host-local interpretation
+      // returned offsets relative to the host, and was distorted by the host's DST gaps).
       const nowTime = this.$date.getTime()
-      const tzTime = new Date(this.$date.toLocaleString('en-US', { timeZone: tz })).getTime()
+      const { year, month, day, hour, minute, second } = getWallComponentsInTimezone(this.$date, tz)
+      const tzTime = Date.UTC(year, month - 1, day, hour, minute, second)
       return Math.round((tzTime - nowTime) / 60000) || 0
     }
 
@@ -163,10 +161,12 @@ export class LocalTime {
    */
   getUTCOffsetString(tz: IANATimezone): string {
     const minutes = this.getUTCOffsetMinutes(tz)
-    const hours = Math.trunc(minutes / 60)
-    const sign = hours < 0 ? '-' : '+'
-    const h = String(Math.abs(hours)).padStart(2, '0')
-    const m = String(minutes % 60).padStart(2, '0')
+    // Sign is taken from minutes (not truncated hours), and minutes are abs-ed,
+    // so negative fractional offsets like Newfoundland -03:30 don't render as `-03:-30`
+    const sign = minutes < 0 ? '-' : '+'
+    const absMinutes = Math.abs(minutes)
+    const h = String(Math.trunc(absMinutes / 60)).padStart(2, '0')
+    const m = String(absMinutes % 60).padStart(2, '0')
     return `${sign}${h}:${m}`
   }
 
@@ -1165,6 +1165,41 @@ function differenceInMonths(a: Date, b: Date): number {
   return -(wholeMonthDiff + ((b.getTime() - anchor) / (anchor2 - anchor)) * sign)
 }
 
+const dateTimeObjectKeys = new Set<keyof DateTimeObject>([
+  'year',
+  'month',
+  'day',
+  'hour',
+  'minute',
+  'second',
+])
+
+// Intl.DateTimeFormat construction is expensive (~30µs), while a cached formatter
+// (via Intl2) converts in ~3µs. Unlike `date.toLocaleString(...)` + `new Date(string)`
+// round-trip, formatToParts is also immune to the host timezone's DST gaps.
+function getWallComponentsInTimezone(date: Date, tz: IANATimezone): DateTimeObject {
+  const fmt = Intl2.DateTimeFormat('en-US', {
+    timeZone: tz,
+    year: 'numeric',
+    month: 'numeric',
+    day: 'numeric',
+    hour: 'numeric',
+    minute: 'numeric',
+    second: 'numeric',
+    hourCycle: 'h23',
+  })
+
+  const dto = {} as DateTimeObject
+
+  for (const { type, value } of fmt.formatToParts(date)) {
+    if (dateTimeObjectKeys.has(type as keyof DateTimeObject)) {
+      dto[type as keyof DateTimeObject] = Number(value)
+    }
+  }
+
+  return dto
+}
+
 interface LocalTimeFn extends LocalTimeFactory {
   (d: LocalTimeInput): LocalTime
 }

package/src/decorators/asyncMemo.decorator.ts

@@ -2,8 +2,9 @@ import { _assert, _assertTypeOf } from '../error/assert.js'
 import type { CommonLogger } from '../log/commonLogger.js'
 import type { AnyAsyncFunction, AnyFunction, AnyObject, MaybeParameters } from '../types.js'
 import { _objectAssign, MISS } from '../types.js'
+import type { MethodDecorator } from './decorator.util.js'
 import { _getTargetMethodSignature } from './decorator.util.js'
-import type { AsyncMemoCache, MethodDecorator } from './memo.util.js'
+import type { AsyncMemoCache } from './memo.util.js'
 import { jsonMemoSerializer } from './memo.util.js'
 
 export interface AsyncMemoOptions<FN> {

package/src/decorators/debounce.decorator.ts

@@ -1,18 +1,69 @@
-import type { DebounceOptions, ThrottleOptions } from './debounce.js'
-import { _debounce, _throttle } from './debounce.js'
+import type { AnyAsyncFunction, AnyFunction } from '../types.js'
+import type {
+  AsyncDebounceOptions,
+  AsyncThrottleOptions,
+  DebounceOptions,
+  ThrottleOptions,
+} from './debounce.js'
+import { _asyncDebounce, _asyncThrottle, _debounce, _throttle } from './debounce.js'
+import type { MethodDecorator } from './decorator.util.js'
 
-export function _Debounce(wait: number, opt: DebounceOptions = {}): MethodDecorator {
+export function _Debounce<T extends AnyFunction>(
+  wait: number,
+  opt: DebounceOptions = {},
+): MethodDecorator<T> {
   return (_target, _key, descriptor) => {
-    const originalFn = descriptor.value
-    descriptor.value = _debounce(originalFn as any, wait, opt)
+    const originalFn = descriptor.value!
+    descriptor.value = _debounce<T>(originalFn, wait, opt)
     return descriptor
   }
 }
 
-export function _Throttle(wait: number, opt: ThrottleOptions = {}): MethodDecorator {
+export function _Throttle<T extends AnyFunction>(
+  wait: number,
+  opt: ThrottleOptions = {},
+): MethodDecorator<T> {
   return (_target, _key, descriptor) => {
-    const originalFn = descriptor.value
-    descriptor.value = _throttle(originalFn as any, wait, opt)
+    const originalFn = descriptor.value!
+    descriptor.value = _throttle<T>(originalFn, wait, opt)
+    return descriptor
+  }
+}
+
+/**
+ * Like `@_Debounce`, but for async methods: every call returns a real Promise resolving with the
+ * coalesced invocation's result, so `await`-ing never yields a stale value or a non-promise
+ *
+ * Be aware that the decorated method may resolve `undefined` if the config yields no invocation,
+ * which the method's `T` type can't express.
+ *
+ * @experimental
+ */
+export function _AsyncDebounce<T extends AnyAsyncFunction>(
+  wait: number,
+  opt: AsyncDebounceOptions = {},
+): MethodDecorator<T> {
+  return (_target, _key, descriptor) => {
+    const originalFn = descriptor.value!
+    descriptor.value = _asyncDebounce<T>(originalFn, wait, opt) as any
+    return descriptor
+  }
+}
+
+/**
+ * Like `@_Throttle`, but for async methods.
+ *
+ * @see {@link _AsyncDebounce}
+ *
+ * @experimental
+ */
+export function _AsyncThrottle<T extends AnyAsyncFunction>(
+  wait: number,
+  opt: AsyncThrottleOptions = {},
+): MethodDecorator<T> {
+  return (_target, _key, descriptor) => {
+    const originalFn = descriptor.value!
+    descriptor.value = _asyncThrottle<T>(originalFn, wait, opt) as any
     return descriptor
   }
 }

package/src/decorators/debounce.ts

@@ -1,116 +1,58 @@
-import type { AnyFunction } from '../types.js'
-
-export interface Cancelable {
-  cancel: () => void
-  flush: () => void
-}
-
-export interface ThrottleOptions {
-  /**
-   * @default true
-   */
-  leading?: boolean
-
-  /**
-   * @default true
-   */
-  trailing?: boolean
-}
-
-export interface DebounceOptions {
-  /**
-   * @default false
-   */
-  leading?: boolean
-
-  /**
-   * @default true
-   */
-  trailing?: boolean
-
-  /**
-   *
-   */
-  maxWait?: number
-}
+import { _anyToError } from '../error/error.util.js'
+import { pDefer } from '../promise/pDefer.js'
+import type { DeferredPromise } from '../promise/pDefer.js'
+import type { AnyAsyncFunction, AnyFunction } from '../types.js'
 
 export function _debounce<T extends AnyFunction>(
   func: T,
   wait: number,
   opt: DebounceOptions = {},
 ): T & Cancelable {
-  let lastArgs: any
-  let lastThis: any
-  let result: any
+  let lastArgs: Parameters<T> | undefined
+  let lastThis: ThisParameterType<T> | undefined
+  let result: ReturnType<T>
   let timerId: number | undefined
-  let lastCallTime: number | undefined
 
-  let lastInvokeTime = 0
   const maxing = 'maxWait' in opt
-
   const { leading = false, trailing = true } = opt
-  const maxWait = maxing ? Math.max(Number(opt.maxWait) || 0, wait) : opt.maxWait
+  const state: DebounceTimerState = {
+    lastCallTime: undefined,
+    lastInvokeTime: 0,
+    wait,
+    maxing,
+    maxWait: maxing ? Math.max(Number(opt.maxWait) || 0, wait) : opt.maxWait,
+  }
 
-  function invokeFunc(time: number): any {
+  function invokeFunc(time: number): ReturnType<T> {
     const args = lastArgs
     const thisArg = lastThis
 
     lastArgs = lastThis = undefined
-    lastInvokeTime = time
-    result = func.apply(thisArg, args)
+    state.lastInvokeTime = time
+    result = func.apply(thisArg, args!)
     return result
   }
 
-  function startTimer(pendingFunc: AnyFunction, wait: number): number {
-    return setTimeout(pendingFunc, wait)
-  }
-
-  function cancelTimer(id: number): void {
-    clearTimeout(id)
-  }
-
-  function leadingEdge(time: number): any {
+  function leadingEdge(time: number): ReturnType<T> {
     // Reset any `maxWait` timer.
-    lastInvokeTime = time
+    state.lastInvokeTime = time
     // Start the timer for the trailing edge.
-    timerId = startTimer(timerExpired, wait)
+    timerId = startTimer(timerExpired, state.wait)
     // Invoke the leading edge.
     return leading ? invokeFunc(time) : result
   }
 
-  function remainingWait(time: number): number {
-    const timeSinceLastCall = time - lastCallTime!
-    const timeSinceLastInvoke = time - lastInvokeTime
-    const timeWaiting = wait - timeSinceLastCall
-
-    return maxing ? Math.min(timeWaiting, maxWait! - timeSinceLastInvoke) : timeWaiting
-  }
-
-  function shouldInvoke(time: number): boolean {
-    const timeSinceLastCall = time - lastCallTime!
-    const timeSinceLastInvoke = time - lastInvokeTime
-
-    // Either this is the first call, activity has stopped and we're at the
-    // trailing edge, the system time has gone backwards and we're treating
-    // it as the trailing edge, or we've hit the `maxWait` limit.
-    return (
-      lastCallTime === undefined ||
-      timeSinceLastCall >= wait ||
-      timeSinceLastCall < 0 ||
-      (maxing && timeSinceLastInvoke >= maxWait!)
-    )
-  }
-
-  function timerExpired(): any {
+  function timerExpired(): void {
     const time = Date.now()
-    if (shouldInvoke(time)) {
-      return trailingEdge(time)
+    if (shouldInvoke(time, state)) {
+      trailingEdge(time)
+      return
     }
     // Restart the timer.
-    timerId = startTimer(timerExpired, remainingWait(time))
+    timerId = startTimer(timerExpired, remainingWait(time, state))
   }
 
-  function trailingEdge(time: number): any {
+  function trailingEdge(time: number): ReturnType<T> {
     timerId = undefined
 
     // Only invoke if we have `lastArgs` which means `func` has been
@@ -126,11 +68,12 @@ export function _debounce<T extends AnyFunction>(
     if (timerId !== undefined) {
       cancelTimer(timerId)
     }
-    lastInvokeTime = 0
-    lastArgs = lastCallTime = lastThis = timerId = undefined
+    state.lastInvokeTime = 0
+    state.lastCallTime = undefined
+    lastArgs = lastThis = timerId = undefined
   }
 
-  function flush(): any {
+  function flush(): ReturnType<T> {
     return timerId === undefined ? result : trailingEdge(Date.now())
   }
 
@@ -138,26 +81,26 @@ export function _debounce<T extends AnyFunction>(
     return timerId !== undefined
   }
 
-  function debounced(this: any, ...args: any[]): any {
+  function debounced(this: ThisParameterType<T>, ...args: Parameters<T>): ReturnType<T> {
     const time = Date.now()
-    const isInvoking = shouldInvoke(time)
+    const isInvoking = shouldInvoke(time, state)
 
     lastArgs = args
     lastThis = this
-    lastCallTime = time
+    state.lastCallTime = time
 
     if (isInvoking) {
       if (timerId === undefined) {
-        return leadingEdge(lastCallTime)
+        return leadingEdge(state.lastCallTime)
       }
-      if (maxing) {
+      if (state.maxing) {
         // Handle invocations in a tight loop.
-        timerId = startTimer(timerExpired, wait)
-        return invokeFunc(lastCallTime)
+        timerId = startTimer(timerExpired, state.wait)
+        return invokeFunc(state.lastCallTime)
       }
     }
     if (timerId === undefined) {
-      timerId = startTimer(timerExpired, wait)
+      timerId = startTimer(timerExpired, state.wait)
     }
     return result
   }
@@ -180,3 +123,319 @@ export function _throttle<T extends AnyFunction>(
     maxWait: wait,
   })
 }
+
+/**
+ * Like `_debounce`, but for async functions.
+ *
+ * Unlike `_debounce` (which returns a stale `result`/`undefined` for suppressed calls),
+ * `_asyncDebounce` always returns a real Promise, resolving with the coalesced invocation's result.
+ *
+ * @experimental
+ */
+export function _asyncDebounce<T extends AnyAsyncFunction>(
+  func: T,
+  wait: number,
+  opt: AsyncDebounceOptions = {},
+): AsyncDebounced<T> {
+  let lastArgs: Parameters<T> | undefined
+  let lastThis: ThisParameterType<T> | undefined
+  let timerId: number | undefined
+  // Promise shared by all calls coalesced into the next invocation (undefined when none pending).
+  let deferred: DeferredPromise<Awaited<ReturnType<T>> | undefined> | undefined
+
+  const { leading = false, trailing = true } = opt
+
+  const maxing = 'maxWait' in opt
+  const maxWait = maxing ? Math.max(Number(opt.maxWait) || 0, wait) : opt.maxWait
+
+  const state: DebounceTimerState = {
+    lastCallTime: undefined,
+    lastInvokeTime: 0,
+    wait,
+    maxing,
+    maxWait,
+  }
+
+  async function invokeFunc(time: number): Promise<void> {
+    const args = lastArgs
+    const thisArg = lastThis
+
+    lastArgs = lastThis = undefined
+    state.lastInvokeTime = time
+
+    // Detach and settle the current batch.
+    const d = deferred!
+    deferred = undefined
+    try {
+      const result = await func.apply(thisArg, args!)
+      d.resolve(result)
+    } catch (err) {
+      d.reject(_anyToError(err))
+    }
+  }
+
+  async function leadingEdge(time: number): Promise<Awaited<ReturnType<T>> | undefined> {
+    // Reset any `maxWait` timer.
+    state.lastInvokeTime = time
+    // Start the timer for the trailing edge.
+    timerId = startTimer(timerExpired, state.wait)
+    // Capture the batch before `invokeFunc` detaches it.
+    const d = deferred!
+    // Invoke the leading edge.
+    if (leading) {
+      await invokeFunc(time)
+    }
+    return d
+  }
+
+  function timerExpired(): void {
+    const time = Date.now()
+    if (shouldInvoke(time, state)) {
+      void trailingEdge(time)
+      return
+    }
+    // Restart the timer.
+    timerId = startTimer(timerExpired, remainingWait(time, state))
+  }
+
+  async function trailingEdge(time: number): Promise<void> {
+    timerId = undefined
+
+    // Only invoke if we have `lastArgs` which means `func` has been
+    // debounced at least once.
+    if (trailing && lastArgs && deferred) {
+      await invokeFunc(time)
+      return
+    }
+    lastArgs = lastThis = undefined
+    // Dropped batch (only reachable with `trailing: false`): no invocation, so resolve `undefined`.
+    if (deferred) {
+      const d = deferred
+      deferred = undefined
+      d.resolve(undefined)
+    }
+  }
+
+  function cancel(): void {
+    if (timerId !== undefined) {
+      cancelTimer(timerId)
+    }
+    state.lastInvokeTime = 0
+    state.lastCallTime = undefined
+    lastArgs = lastThis = timerId = undefined
+    // Reject pending awaiters.
+    if (deferred) {
+      const d = deferred
+      deferred = undefined
+      d.reject(new Error('asyncDebounce cancelled'))
+    }
+  }
+
+  async function flush(): Promise<Awaited<ReturnType<T>> | undefined> {
+    if (timerId === undefined || !deferred) {
+      return undefined
+    }
+    const d = deferred
+    cancelTimer(timerId)
+    await trailingEdge(Date.now())
+    return d
+  }
+
+  function pending(): boolean {
+    return timerId !== undefined
+  }
+
+  async function debounced(
+    this: ThisParameterType<T>,
+    ...args: Parameters<T>
+  ): Promise<Awaited<ReturnType<T>> | undefined> {
+    const time = Date.now()
+    const isInvoking = shouldInvoke(time, state)
+
+    lastArgs = args
+    lastThis = this
+    state.lastCallTime = time
+
+    deferred ||= pDefer<Awaited<ReturnType<T>> | undefined>()
+    const currentDeferred = deferred
+
+    if (isInvoking) {
+      if (timerId === undefined) {
+        return leadingEdge(state.lastCallTime)
+      }
+      if (state.maxing) {
+        // Handle invocations in a tight loop.
+        timerId = startTimer(timerExpired, state.wait)
+        await invokeFunc(state.lastCallTime)
+        return currentDeferred
+      }
+    }
+    if (timerId === undefined) {
+      timerId = startTimer(timerExpired, state.wait)
+    }
+    return currentDeferred
+  }
+
+  debounced.cancel = cancel
+  debounced.flush = flush
+  debounced.pending = pending
+  return debounced as any
+}
+
+/**
+ * Like `_throttle`, but for async functions. See `_asyncDebounce` for the Promise semantics.
+ *
+ * @experimental
+ */
+export function _asyncThrottle<T extends AnyAsyncFunction>(
+  func: T,
+  wait: number,
+  opt: AsyncThrottleOptions = {},
+): AsyncDebounced<T> {
+  return _asyncDebounce(func, wait, {
+    leading: true,
+    trailing: true,
+    ...opt,
+    maxWait: wait,
+  })
+}
+
+function remainingWait(time: number, state: DebounceTimerState): number {
+  const { lastCallTime, lastInvokeTime, wait, maxing, maxWait } = state
+  const timeSinceLastCall = time - lastCallTime!
+  const timeSinceLastInvoke = time - lastInvokeTime
+  const timeWaiting = wait - timeSinceLastCall
+
+  return maxing ? Math.min(timeWaiting, maxWait! - timeSinceLastInvoke) : timeWaiting
+}
+
+function shouldInvoke(time: number, state: DebounceTimerState): boolean {
+  const { lastCallTime, lastInvokeTime, wait, maxing, maxWait } = state
+  const timeSinceLastCall = time - lastCallTime!
+  const timeSinceLastInvoke = time - lastInvokeTime
+
+  // Either this is the first call, activity has stopped and we're at the
+  // trailing edge, the system time has gone backwards and we're treating
+  // it as the trailing edge, or we've hit the `maxWait` limit.
+  return (
+    lastCallTime === undefined ||
+    timeSinceLastCall >= wait ||
+    timeSinceLastCall < 0 ||
+    (maxing && timeSinceLastInvoke >= maxWait!)
+  )
+}
+
+function startTimer(pendingFunc: AnyFunction, wait: number): number {
+  return setTimeout(pendingFunc, wait)
+}
+
+function cancelTimer(id: number): void {
+  clearTimeout(id)
+}
+
+interface DebounceTimerState {
+  lastCallTime: number | undefined
+  lastInvokeTime: number
+  wait: number
+  maxing: boolean
+  maxWait: number | undefined
+}
+
+export interface Cancelable {
+  cancel: () => void
+  flush: () => void
+}
+
+/**
+ * Like `Cancelable`, but for the async debounced functions: `flush()` resolves with the flushed
+ * invocation's result (or `undefined` if nothing was pending), and `pending()` is exposed.
+ */
+export interface AsyncCancelable<T> {
+  cancel: () => void
+  flush: () => Promise<T | undefined>
+  pending: () => boolean
+}
+
+export interface ThrottleOptions {
+  /**
+   * Invoke on the leading edge of the window (immediately, on the first call).
+   *
+   * @default true
+   */
+  leading?: boolean
+
+  /**
+   * Invoke on the trailing edge of the window (after `wait` has elapsed).
+   *
+   * @default true
+   */
+  trailing?: boolean
+}
+
+export interface DebounceOptions {
+  /**
+   * Invoke on the leading edge of the window (immediately, on the first call).
+   *
+   * @default false
+   */
+  leading?: boolean
+
+  /**
+   * Invoke on the trailing edge of the window (after `wait` has elapsed).
+   *
+   * @default true
+   */
+  trailing?: boolean
+
+  /**
+   * Maximum time `func` is allowed to be delayed before it's forcibly invoked.
+   */
+  maxWait?: number
+}
+
+export interface AsyncThrottleOptions {
+  /**
+   * Invoke on the leading edge of the window (immediately, on the first call).
+   *
+   * @default true
+   */
+  leading?: boolean
+
+  /**
+   * Invoke on the trailing edge of the window (after `wait` has elapsed).
+   *
+   * When `false`, calls dropped within the window (not served by a leading invocation) resolve
+   * with `undefined`. There's no invocation for them to await. This is why the returned function
+   * can resolve with `undefined` even though the original function's return type doesn't express that.
+   *
+   * @default true
+   */
+  trailing?: boolean
+}
+
+export interface AsyncDebounceOptions extends AsyncThrottleOptions {
+  /**
+   * Invoke on the leading edge of the window (immediately, on the first call).
+   *
+   * @default false
+   */
+  leading?: boolean
+
+  /**
+   * Maximum time `func` is allowed to be delayed before it's forcibly invoked.
+   */
+  maxWait?: number
+}
+
+/**
+ * The function returned by `_asyncDebounce`/`_asyncThrottle`. Same signature as `T`, but resolves
+ * `Awaited<ReturnType<T>> | undefined`
+ *
+ * This is because some configurations (e.g. `trailing: false`) may drop calls without invoking
+ * the original function, so there's no result to await.
+ */
+export type AsyncDebounced<T extends AnyAsyncFunction> = ((
+  this: ThisParameterType<T>,
+  ...args: Parameters<T>
+) => Promise<Awaited<ReturnType<T>> | undefined>) &
+  AsyncCancelable<Awaited<ReturnType<T>>>