timezone-soft 1.5.2 → 1.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 spencer kelly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,160 +1,193 @@
 <div align="center">
-
-  <div>parse abbreviated, sloppy, and informal timezone names</div>
-  <div><img src="https://cloud.githubusercontent.com/assets/399657/23590290/ede73772-01aa-11e7-8915-181ef21027bc.png" /></div>
-
-  <div align="center">
-    <a href="https://npmjs.org/package/timezone-soft">
-      <img src="https://img.shields.io/npm/v/timezone-soft.svg?style=flat-square" />
-    </a>
-    <!-- <a href="https://codecov.io/gh/spencermountain/timezone-soft">
-      <img src="https://codecov.io/gh/spencermountain/timezone-soft/branch/master/graph/badge.svg" />
-    </a> -->
-    <a href="https://unpkg.com/timezone-soft/builds/timezone-soft.min.js">
-      <img src="https://badge-size.herokuapp.com/spencermountain/timezone-soft/master/builds/timezone-soft.min.js" />
-    </a>
-  </div>
-  <div align="center">
-    <code>npm install timezone-soft</code>
-  </div>
-  <sub>
-    by
-    <a href="https://spencermountain.github.io/">Spencer Kelly</a>
-  </sub>
-  <div align="center">
-    <sup><i>(formerly called 'spacetime-informal')</i></sup>
-  </div>
+  <img src="https://cloud.githubusercontent.com/assets/399657/23590290/ede73772-01aa-11e7-8915-181ef21027bc.png" />
+  <div>informal timezone lookup</div>
+  <a href="https://npmjs.org/package/timezone-soft">
+    <img src="https://img.shields.io/npm/v/timezone-soft.svg?style=flat-square" />
+  </a>
+  <a href="https://bundlephobia.com/result?p=timezone-soft@latest">
+    <img src="https://badgen.net/bundlejs/min/timezone-soft" />
+  </a>
+  <div><code>npm install timezone-soft</code></div>
 </div>
-<p></p>
 
 <!-- spacer -->
-<img height="25px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+<img height="50px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
 
 ```js
-import soft from 'timezone-soft'
-
-// get an IANA tz from user input
-let timezones = soft('milwaukee')[0]
-/*[{
-    iana: 'America/Chicago',
-    standard: { name: 'Central Standard Time', abbrev: 'CST' },
-    daylight: { name: 'Central Daylight Time', abbrev: 'CDT' }
-  }
-]*/
+import tzSoft from 'timezone-soft'
+
+const matches = tzSoft('milwaukee')
+matches[0].iana // 'America/Chicago'
 ```
 
+People are not often aware of timezone [IANA IDs](https://www.iana.org/time-zones), and tend to use informal schemes to refer to timezones - things like `'PST'`, `'eastern time'`, `'vancouver bc'`, and `'china'`. 
+
+These names have cultural overlap, and their meaning can depend on the date. 
+
+This library applies opinionated heuristics to help turn this user-input into ranked matching IANA candidates.
+
+Originally built for [spacetime](https://github.com/spencermountain/spacetime),
+and formerly called `timezone-soft-informal`. This is a compressed dictionary of lookup terms for timezone ids, and some basic ranking heuristics when >1 results.
+
 <!-- spacer -->
 <img height="25px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
 
-**[IANA timezone codes](https://www.iana.org/time-zones)** are the official reference for timezone information, and is what you should use, whenever possible.
-
-Humans though, _are goofballs_, and use a whole different informal scheme:
+<div align="center">
+  <img src="https://cloud.githubusercontent.com/assets/399657/23590290/ede73772-01aa-11e7-8915-181ef21027bc.png" />
+</div>
 
----
+### Usage
+```js
+const tzSoft = require('timezone-soft') //commonjs supported
 
-- In (North) America: **PST, MST, EST**...
-- in Europe (lately): **WEST, CEST, EEST**...
-- in Africa: **EAT, CAT, WAST**...
-- in Australia: **AWST, AEDT, ACST**...
+tzSoft('EST')[0].iana // 'America/New_York'
+tzSoft('central')[0].iana // 'America/Chicago'
+tzSoft('venezuela')[0].iana // 'America/Caracas'
+tzSoft('south east asia')[0].iana // 'Asia/Bangkok'
+```
 
----
+`tzSoft(input: string)`
 
-#### these line-up with the IANA codes sometimes.
+This returns an array of matching timezone objects, ordered by preference. An empty or
+unrecognized string returns `[]`
 
-#### ...other times they don't.
+A match looks like this:
+```js
+{
+  name: 'Central Time',
+  iana: 'America/Chicago',
+  standard: {
+    name: 'Central Standard Time',
+    abbr: 'CST',
+    offset: -6
+  },
+  daylight: {
+    name: 'Central Daylight Time',
+    abbr: 'CDT',
+    offset: -5,
+    start: '2nd-sun-mar-2h',
+    end: '1st-sun-nov-2h'
+  },
+  long: '(UTC-06:00) Central Time (US & Canada)'
+}
+```
 
-<!-- spacer -->
-<img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+Offsets are hours east of UTC; negative values are west of UTC. `daylight` can be
+`null`. 
 
-These names also collide -
+`start` and `end` values are descriptive rule strings.
 
-'**_IST_**' is used to mean:
 
-- '_Indian Stardard Time_'
-- '_Irish Stardard Time_'
-- '_Israeli Stardard Time_'
+## Ambiguous inputs
 
-These names also produce all-sorts of ambiguities, regarding DST-changes-
+Abbreviations can describe several places. For example:
 
-Both Winnipeg and Mexico City are **CST**, but have a much different DST schedule:
-![image](https://user-images.githubusercontent.com/399657/52489224-b34d0e00-2b8f-11e9-9de8-0688bec52464.png)
+```js
+soft('IST').map(zone => zone.iana)
+// ['Asia/Kolkata', 'Europe/Dublin', 'Asia/Jerusalem', 'Asia/Colombo']
+```
 
-_(thanks [timeanddate.com](https://www.timeanddate.com)!)_
+Explicit IANA IDs containing `/` are resolved case-insensitively through the pinned
+IANA **2026d** Zone/Link table before informal matching. Unknown IDs are not guessed
+from their city component. A recognized ID without bundled display metadata returns
+`[]`. Curated non-IANA phrases containing `/` can still match registered aliases.
 
--of course, there's a bunch of political/historical/disputed stuff going on, too. Apologies if this library steps into that unknowingly.
+All returned IDs use that table's canonical targets. For example, `Europe/Kiev`
+returns `Europe/Kyiv`, `Asia/Kashgar` returns `Asia/Urumqi` (UTC+6, distinct from
+Shanghai's UTC+8), and `America/Yellowknife` returns `America/Edmonton`.
+This policy uses the main IANA files plus `backward`, not the optional `backzone`
+historical split. Ordinary abbreviations such as `EST` remain informal queries.
 
-<img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+Alias matches are sorted by
+the number of packed aliases associated with each zone, descending. Ties preserve
+insertion order in the source data. Canonicalization then merges duplicate targets
+while preserving their first occurrence. This is a heuristic, not a population ranking
+or a confidence score; adding aliases can change the preferred result.
 
-...so that's what we're trying to fix - to _'soften'_ this exchange, between human and IANA timezone nomenclature, using some _opinionated-but-common-sense_ rules and decision-making.
+Show all candidates when ambiguity matters, or ask for a city or IANA ID. The
+library does not use the user's location to choose a result. Regression fixtures
+cover the ordering of `CST`, `IST`, and `BST`.
 
-It was originally built for use in the _[spacetime timezone library](https://github.com/spencermountain/spacetime)_.
+## UTC and GMT offsets
 
-<!-- spacer -->
-<img height="25px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+`UTC` (including lowercase or surrounding whitespace) resolves only to `Etc/UTC`,
+with abbreviation `UTC` and name `Coordinated Universal Time`. The aliases `UCT`,
+`universal`, `zulu`, and `coordinated universal time` resolve to the same record.
+`GMT` resolves to `Etc/GMT`. Geographic aliases cannot outrank these inputs.
 
-### Usage
+Whole-hour offsets from UTC-12 through UTC+14 are supported:
 
 ```js
-const soft = require('timezone-soft')
+soft('UTC+0')[0].iana // 'Etc/GMT'
+soft('UTC+14')[0].iana // 'Etc/GMT-14'
+soft('-5h')[0].iana // 'Etc/GMT+5'
+```
 
-soft('EST')
-// 'America/New_York'
+Surrounding whitespace is accepted for offset inputs. `UTC-5` means five hours
+behind UTC. For compatibility, `GMT+5` follows the reversed IANA `Etc/GMT+5`
+convention; its numeric offset and `long` description use the normal UTC sign.
+`Etc/GMT+13` and `Etc/GMT+14` return `[]` because they are not IANA IDs;
+`Etc/GMT-13` and `Etc/GMT-14` remain valid.
 
-soft('central')
-// 'America/Chicago'
+Fractional offset strings such as `UTC+5:30` return `[]`: the IANA fixed-offset
+`Etc/GMT` IDs have whole-hour precision. Use a named zone such as `Asia/Kolkata` or
+`india` instead. See the [IANA definitions](https://data.iana.org/time-zones/tzdb/etcetera).
 
-soft('venezuela')
-// 'America/Caracas'
+## Dates and daylight saving time
 
-soft('south east asia')
-// 'Asia/Bangkok'
-```
+This package finds timezone names and supplies curated display metadata. Its
+bundled DST rules are approximate, are not versioned by year, and are not suitable
+for calculating historical or future transitions. See the
+[data notes](data/README.md) for the rule syntax and provenance limitations.
 
-Typescript/Deno/Webpack:
+Use a date-aware timezone library to determine the applicable abbreviation at a
+specific instant. For example, with [spacetime](https://github.com/spencermountain/timezone-soft):
 
 ```js
-import soft from 'timezone-soft'
+import spacetime from 'spacetime'
+import tzSoft from 'timezone-soft'
+
+const display = tzSoft('montreal')[0]
+if (display) {
+  const now = spacetime.now(display.iana)
+  const info = now.isDST() && display.daylight ? display.daylight : display.standard
+  console.log(now.time() + ' ' + info.abbr)
+}
 ```
 
-it was built to be as forgiving as possible, and return the most common-sense IANA timezone id from user-input.
-
-<div align="center">
-  <img height="50px" src="https://user-images.githubusercontent.com/399657/68221814-05ed1680-ffb8-11e9-8b6b-c7528d163871.png"/>
-</div>
-
----
+The `standard` and `daylight` fields are conventional display categories, not
+IANA's `tm_isdst` flags. In Dublin, `standard` means winter GMT (UTC+0, Greenwich
+Mean Time), and `daylight` means summer IST (UTC+1, Irish Standard Time). IANA's
+native model treats Irish summer as standard and winter as negative DST; this API
+retains its existing winter/summer arrangement for compatibility. Do not select a
+field using a raw IANA DST flag without reconciling those conventions.
 
-<!-- spacer -->
-<img height="25px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
+The identifier table is versioned independently of display metadata. The returned
+metadata is only as current as this package's curated data. Coverage includes
+`America/Ciudad_Juarez` (Mountain time with US DST rules) and
+`America/Coyhaique` (permanent UTC−3). Runtime coverage checks flag new missing
+records.
 
-### DST
 
-Often, the proper timezone name will depend on which date you are referencing.
-You can reckon this pretty-easily with [spacetime](https://github.com/spencermountain/spacetime), like this:
+## TypeScript
 
-```js
-const spacetime = require('spacetime')
-const soft = require('timezone-soft')
+```ts
+import tzSoft, { type DisplayFormat } from 'timezone-soft'
 
-let display = soft('montreal')[0]
-let show = display.standard.abbrev
+const matches: DisplayFormat[] = tzSoft('montreal')
+const zone = matches[0]
 
-// are we in standard time, or daylight time?
-let s = spacetime.now(display.iana)
-if (display.daylight && s.isDST()) {
-  show = display.daylight.abbrev
+if (zone) {
+  console.log(zone.iana) // 'America/Toronto'
+  console.log(zone.standard.abbr) // 'EST'
+  console.log(zone.daylight?.abbr) // 'EDT'; undefined for zones without DST
+} else {
+  console.log('No matching timezone')
 }
-console.log(s.time() + ' ' + show)
-// '4:20pm EDT'
 ```
 
-<!-- spacer -->
-<img height="25px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>
-
-work-in-progress!
-
 ### See also
 
-- [TimeZoneNames](https://github.com/mattjohnsonpint/TimeZoneNames) .NET Standard Library by Matt Johnson-Pint
+- [TimeZoneNames](https://github.com/mattjohnsonpint/TimeZoneNames) for .NET.
 
-MIT
+MIT, PRs welcome