ts-cache-mongoose 2.0.0 → 2.1.0

package/src/ms.ts

@@ -4,52 +4,63 @@ const h = m * 60
 const d = h * 24
 const w = d * 7
 const y = d * 365.25
+const mo = y / 12
 
-// NOSONAR — regex from ms package, intentionally covers all time unit aliases
-const RE = /^(-?(?:\d+)?\.?\d+)\s*(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i
-
-const UNITS: Record<string, number> = {
-  years: y,
-  year: y,
-  yrs: y,
-  yr: y,
-  y,
-  weeks: w,
-  week: w,
-  w,
-  days: d,
-  day: d,
-  d,
-  hours: h,
-  hour: h,
-  hrs: h,
-  hr: h,
-  h,
-  minutes: m,
-  minute: m,
-  mins: m,
-  min: m,
-  m,
-  seconds: s,
-  second: s,
-  secs: s,
-  sec: s,
-  s,
+export const UNITS = {
   milliseconds: 1,
   millisecond: 1,
   msecs: 1,
   msec: 1,
   ms: 1,
-}
+  seconds: s,
+  second: s,
+  secs: s,
+  sec: s,
+  s,
+  minutes: m,
+  minute: m,
+  mins: m,
+  min: m,
+  m,
+  hours: h,
+  hour: h,
+  hrs: h,
+  hr: h,
+  h,
+  days: d,
+  day: d,
+  d,
+  weeks: w,
+  week: w,
+  w,
+  months: mo,
+  month: mo,
+  mo,
+  years: y,
+  year: y,
+  yrs: y,
+  yr: y,
+  y,
+} as const satisfies Record<string, number>
+
+export type Unit = keyof typeof UNITS
+
+export type Duration = number | `${number}` | `${number}${Unit}` | `${number} ${Unit}`
+
+const unitPattern = Object.keys(UNITS)
+  .sort((a, b) => b.length - a.length)
+  .join('|')
+
+const RE = new RegExp(String.raw`^(-?(?:\d+)?\.?\d+)\s*(${unitPattern})?$`, 'i')
 
-export const ms = (val: string): number => {
+export const ms = (val: Duration): number => {
   const str = String(val)
-  if (str.length > 100) return 0
+  if (str.length > 100) return Number.NaN
 
   const match = RE.exec(str)
-  if (!match) return 0
+  if (!match) return Number.NaN
 
   const n = Number.parseFloat(match[1] ?? '')
   const type = (match[2] ?? 'ms').toLowerCase()
-  return n * (UNITS[type] ?? 0)
+  return n * (UNITS[type as Unit] ?? 0)
 }

package/src/types.ts

@@ -1,19 +1,20 @@
 import type { RedisOptions } from 'ioredis'
+import type { Duration } from './ms'
 
-export type CacheTTL = number | string
+export type { Duration } from './ms'
 
 export type CacheData = Record<string, unknown> | Record<string, unknown>[] | unknown[] | number | undefined
 
 export type CacheOptions = {
   engine: 'memory' | 'redis'
   engineOptions?: RedisOptions
-  defaultTTL?: CacheTTL
+  defaultTTL?: Duration
   debug?: boolean
 }
 
 export interface CacheEngine {
   get: (key: string) => Promise<CacheData> | CacheData
-  set: (key: string, value: CacheData, ttl?: CacheTTL) => Promise<void> | void
+  set: (key: string, value: CacheData, ttl?: Duration) => Promise<void> | void
   del: (key: string) => Promise<void> | void
   clear: () => Promise<void> | void
   close: () => Promise<void> | void

package/tests/ms.test.ts

@@ -1,68 +1,78 @@
 import { describe, expect, it } from 'vitest'
 
-import { ms } from '../src/ms'
+import { ms, UNITS } from '../src/ms'
+
+const { s, m, h, d, w, mo, y } = UNITS
 
 describe('ms', () => {
+  it('should parse milliseconds', () => {
+    expect(ms('100ms')).toBe(100)
+    expect(ms('500 milliseconds')).toBe(500)
+    expect(ms('1 millisecond')).toBe(1)
+    expect(ms('200 msec')).toBe(200)
+    expect(ms('300 msecs')).toBe(300)
+  })
+
   it('should parse seconds', () => {
-    expect(ms('1s')).toBe(1000)
-    expect(ms('5 seconds')).toBe(5000)
-    expect(ms('30 sec')).toBe(30000)
-    expect(ms('1 second')).toBe(1000)
-    expect(ms('2 secs')).toBe(2000)
+    expect(ms('1s')).toBe(s)
+    expect(ms('5 seconds')).toBe(5 * s)
+    expect(ms('30 sec')).toBe(30 * s)
+    expect(ms('1 second')).toBe(s)
+    expect(ms('2 secs')).toBe(2 * s)
   })
 
   it('should parse minutes', () => {
-    expect(ms('1m')).toBe(60000)
-    expect(ms('5 minutes')).toBe(300000)
-    expect(ms('1 minute')).toBe(60000)
-    expect(ms('2 min')).toBe(120000)
-    expect(ms('3 mins')).toBe(180000)
+    expect(ms('1m')).toBe(m)
+    expect(ms('5 minutes')).toBe(5 * m)
+    expect(ms('1 minute')).toBe(m)
+    expect(ms('2 min')).toBe(2 * m)
+    expect(ms('3 mins')).toBe(3 * m)
   })
 
   it('should parse hours', () => {
-    expect(ms('1h')).toBe(3600000)
-    expect(ms('2 hours')).toBe(7200000)
-    expect(ms('1 hour')).toBe(3600000)
-    expect(ms('3 hr')).toBe(10800000)
-    expect(ms('4 hrs')).toBe(14400000)
+    expect(ms('1h')).toBe(h)
+    expect(ms('2 hours')).toBe(2 * h)
+    expect(ms('1 hour')).toBe(h)
+    expect(ms('3 hr')).toBe(3 * h)
+    expect(ms('4 hrs')).toBe(4 * h)
   })
 
   it('should parse days', () => {
-    expect(ms('1d')).toBe(86400000)
-    expect(ms('2 days')).toBe(172800000)
-    expect(ms('1 day')).toBe(86400000)
+    expect(ms('1d')).toBe(d)
+    expect(ms('2 days')).toBe(2 * d)
+    expect(ms('1 day')).toBe(d)
   })
 
   it('should parse weeks', () => {
-    expect(ms('1w')).toBe(604800000)
-    expect(ms('2 weeks')).toBe(1209600000)
-    expect(ms('1 week')).toBe(604800000)
+    expect(ms('1w')).toBe(w)
+    expect(ms('2 weeks')).toBe(2 * w)
+    expect(ms('1 week')).toBe(w)
   })
 
-  it('should parse years', () => {
-    expect(ms('1y')).toBe(31557600000)
-    expect(ms('1 year')).toBe(31557600000)
-    expect(ms('2 yrs')).toBe(63115200000)
-    expect(ms('1 yr')).toBe(31557600000)
+  it('should parse months', () => {
+    expect(ms('1mo')).toBe(mo)
+    expect(ms('1 month')).toBe(mo)
+    expect(ms('2 months')).toBe(2 * mo)
+    expect(ms('6mo')).toBe(6 * mo)
+    expect(ms('0.5mo')).toBe(0.5 * mo)
   })
 
-  it('should parse milliseconds', () => {
-    expect(ms('100ms')).toBe(100)
-    expect(ms('500 milliseconds')).toBe(500)
-    expect(ms('1 millisecond')).toBe(1)
-    expect(ms('200 msec')).toBe(200)
-    expect(ms('300 msecs')).toBe(300)
+  it('should parse years', () => {
+    expect(ms('1y')).toBe(y)
+    expect(ms('1 year')).toBe(y)
+    expect(ms('2 yrs')).toBe(2 * y)
+    expect(ms('1 yr')).toBe(y)
   })
 
   it('should parse decimal values', () => {
-    expect(ms('1.5h')).toBe(5400000)
-    expect(ms('0.5d')).toBe(43200000)
-    expect(ms('.5s')).toBe(500)
+    expect(ms('1.5h')).toBe(1.5 * h)
+    expect(ms('0.5d')).toBe(0.5 * d)
+    expect(ms('.5s')).toBe(0.5 * s)
   })
 
   it('should parse negative values', () => {
-    expect(ms('-1s')).toBe(-1000)
-    expect(ms('-3m')).toBe(-180000)
+    expect(ms('-1s')).toBe(-s)
+    expect(ms('-3m')).toBe(-3 * m)
   })
 
   it('should default to milliseconds without unit', () => {
@@ -71,23 +81,33 @@ describe('ms', () => {
   })
 
   it('should be case insensitive', () => {
-    expect(ms('1S')).toBe(1000)
-    expect(ms('1M')).toBe(60000)
-    expect(ms('1H')).toBe(3600000)
+    // @ts-expect-error runtime check
+    expect(ms('1S')).toBe(s)
+    // @ts-expect-error runtime check
+    expect(ms('1M')).toBe(m)
+    // @ts-expect-error runtime check
+    expect(ms('1H')).toBe(h)
   })
 
-  it('should return 0 for invalid strings', () => {
-    expect(ms('invalid')).toBe(0)
-    expect(ms('')).toBe(0)
-    expect(ms('abc123')).toBe(0)
+  it('should return NaN for invalid strings', () => {
+    // @ts-expect-error testing invalid input
+    expect(ms('invalid')).toBeNaN()
+    // @ts-expect-error testing invalid input
+    expect(ms('')).toBeNaN()
+    // @ts-expect-error testing invalid input
+    expect(ms('abc123')).toBeNaN()
   })
 
-  it('should return 0 for strings longer than 100 characters', () => {
-    expect(ms('a'.repeat(101))).toBe(0)
+  it('should return NaN for strings longer than 100 characters', () => {
+    // @ts-expect-error testing invalid input
+    expect(ms('a'.repeat(101))).toBeNaN()
   })
 
   it('should handle whitespace between number and unit', () => {
-    expect(ms('1 s')).toBe(1000)
-    expect(ms('5  minutes')).toBe(300000)
+    expect(ms('1 s')).toBe(s)
+    expect(ms('5  minutes')).toBe(5 * m)
+    expect(ms('1 mo')).toBe(mo)
+    expect(ms('1 week')).toBe(w)
+    expect(ms('1 year')).toBe(y)
   })
 })

package/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "include": ["src"],
   "compilerOptions": {
-    "target": "ES2021",
-    "lib": ["ES2021"],
+    "target": "ES2022",
+    "lib": ["ES2022"],
     "types": ["node"],
     "module": "Preserve",
     "moduleResolution": "bundler",
@@ -18,7 +18,6 @@
     "experimentalDecorators": true,
     "exactOptionalPropertyTypes": true,
     "forceConsistentCasingInFileNames": true,
-    "importHelpers": true,
     "isolatedModules": true,
     "noEmitOnError": true,
     "noFallthroughCasesInSwitch": true,