@operato/utils 10.16.2 → 10.29.1

package/test/when.test.ts

@@ -0,0 +1,127 @@
+import { expect } from '@open-wc/testing'
+
+import {
+  availableZones,
+  dayHeadings,
+  formatWhen,
+  msOf,
+  nextZone,
+  resolveZone,
+  zoneAbbr,
+  ZONE_ORDER
+} from '../src/when.js'
+
+/**
+ * The moment rule, carried over from operato-twin (test/when-core.test.ts) with its cases: follow the
+ * screen's language, read the zone given, and never make up a zone that is not there.
+ */
+
+/** 2026-08-22 08:23 UTC - 17:23 the same day in Seoul, 01:23 the same day in Los Angeles. */
+const AT = Date.UTC(2026, 7, 22, 8, 23, 0)
+
+describe('formatWhen', () => {
+  it('draws in the language it is given, not the browser setting', () => {
+    const ko = formatWhen(AT, { lang: 'ko', zone: 'Asia/Seoul' })!
+    const en = formatWhen(AT, { lang: 'en-US', zone: 'Asia/Seoul' })!
+    expect(ko).to.include('2026년')
+    expect(ko).to.not.equal(en)
+  })
+
+  it('writes a 24-hour clock in all five languages', () => {
+    for (const lang of ['ko', 'en-US', 'ja', 'zh', 'es']) {
+      const out = formatWhen(AT, { lang, zone: 'Asia/Seoul' })!
+      expect(out, lang).to.include('17:23')
+      expect(/AM|PM|오전|오후/.test(out), `${lang}: ${out}`).to.equal(false)
+    }
+  })
+
+  it('reads the zone it is given', () => {
+    const seoul = formatWhen(AT, { lang: 'en-US', zone: 'Asia/Seoul' })!
+    const la = formatWhen(AT, { lang: 'en-US', zone: 'America/Los_Angeles' })!
+    expect(seoul).to.not.equal(la)
+  })
+
+  it('does not draw on another clock when the zone is unknown or missing', () => {
+    expect(formatWhen(AT, { lang: 'ko', zone: 'Mars/Olympus' })).to.equal(null)
+    expect(formatWhen(AT, { lang: 'ko', zone: resolveZone('domain', null) })).to.equal(null)
+  })
+
+  it('lets the caller choose how much to write', () => {
+    const opts = { lang: 'en-US', zone: 'UTC' }
+    expect(/:/.test(formatWhen(AT, { ...opts, style: 'date' })!)).to.equal(false)
+    expect(formatWhen(AT, { ...opts, style: 'time' })).to.match(/08:23/)
+    expect(formatWhen(AT, { ...opts, style: 'precise' })).to.match(/:00/)
+  })
+})
+
+describe('zones', () => {
+  it('without a domain zone, that choice cannot be made', () => {
+    expect(availableZones(null)).to.deep.equal(['local', 'utc'])
+    expect(availableZones('')).to.deep.equal(['local', 'utc'])
+    expect(availableZones('Asia/Seoul')).to.deep.equal([...ZONE_ORDER])
+  })
+
+  it("does not swap a missing domain zone for the viewer's own", () => {
+    expect(resolveZone('domain', null)).to.equal(null)
+    expect(resolveZone('local', null)).to.equal(undefined)
+    expect(resolveZone('utc', null)).to.equal('UTC')
+    expect(resolveZone('domain', 'Asia/Seoul')).to.equal('Asia/Seoul')
+  })
+
+  it('steps round and skips what cannot be chosen', () => {
+    expect(nextZone('local', 'Asia/Seoul')).to.equal('utc')
+    expect(nextZone('utc', 'Asia/Seoul')).to.equal('domain')
+    expect(nextZone('domain', 'Asia/Seoul')).to.equal('local')
+    expect(nextZone('utc', null)).to.equal('local')
+    expect(nextZone('domain', null)).to.equal('local')
+  })
+
+  it('names a zone as it is on that date - summer time included', () => {
+    expect(zoneAbbr('UTC', 'en-US', AT)).to.equal('UTC')
+    expect(zoneAbbr(null, 'en-US', AT)).to.equal(null)
+    expect(zoneAbbr('Mars/Olympus', 'en-US', AT)).to.equal(null)
+    const winter = zoneAbbr('America/Los_Angeles', 'en-US', Date.UTC(2026, 0, 15, 12))
+    const summer = zoneAbbr('America/Los_Angeles', 'en-US', Date.UTC(2026, 6, 15, 12))
+    expect(winter).to.not.equal(summer)
+  })
+})
+
+describe('msOf', () => {
+  it('unreadable is null, never "Invalid Date"', () => {
+    for (const value of [null, undefined, '', 'yesterday', Number.NaN, new Date('x')]) {
+      expect(msOf(value), String(value)).to.equal(null)
+    }
+    expect(formatWhen('yesterday', { lang: 'ko' })).to.equal(null)
+  })
+
+  it('takes a number, a string or a Date', () => {
+    expect(msOf(AT)).to.equal(AT)
+    expect(msOf(new Date(AT).toISOString())).to.equal(AT)
+    expect(msOf(new Date(AT))).to.equal(AT)
+  })
+})
+
+describe('dayHeadings', () => {
+  it('puts the date on the first row even when there is one day', () => {
+    expect(dayHeadings(['Aug 27', 'Aug 27', 'Aug 27'])).to.deep.equal(['Aug 27', '', ''])
+  })
+
+  it('and only where the date changes', () => {
+    expect(dayHeadings(['Aug 27', 'Aug 27', 'Aug 26', 'Aug 26', 'Aug 25'])).to.deep.equal([
+      'Aug 27',
+      '',
+      'Aug 26',
+      '',
+      'Aug 25'
+    ])
+  })
+
+  it('a row with no date does not clear the one before it', () => {
+    expect(dayHeadings(['Aug 27', '', 'Aug 27', 'Aug 26'])).to.deep.equal(['Aug 27', '', '', 'Aug 26'])
+  })
+
+  it('a date that comes back is said again - a broken sort is not hidden', () => {
+    expect(dayHeadings(['Aug 27', 'Aug 26', 'Aug 27'])).to.deep.equal(['Aug 27', 'Aug 26', 'Aug 27'])
+    expect(dayHeadings([])).to.deep.equal([])
+  })
+})