chore: release 0.0.17

* feat: adds support for parsing time zone offsets in the format [+-]HH:mm (#39)

* Add support for parsing time zone offsets in the format [+-]HH:mm

* Fix ISO 8601 regex to support colons in timezone offsets.

* test: tweaks date test

* docs: adds size ref to intro

---------

Co-authored-by: Kouta Motegi <motegi@sansan.com>

Author: justin-schroeder

.size-limit.cjs

@@ -14,6 +14,6 @@ module.exports = [
 
   { path, limit: "2.9 kb", import: "{ format }", name: "format" },
   { path, limit: "4.3 kb", import: "{ parse }", name: "parse" },
-  { path, limit: "5.1 kb", import: "*", name: "all esm" },
-  { path: "./dist/index.cjs", limit: "5.4 kb", import: "*", name: "all cjs" },
+  { path, limit: "5.2 kb", import: "*", name: "all esm" },
+  { path: "./dist/index.cjs", limit: "5.5 kb", import: "*", name: "all cjs" },
 ]

README.md

@@ -10,7 +10,7 @@ Tempo is a new library in a proud tradition of JavaScript date and time librarie
 
 Tempo is best thought of as a collection of utilities for working with `Date` objects — an important distinction from other libraries that provide custom date primitives. Under the hood, Tempo mines JavaScript's `Intl.DateTimeFormat` to extract complex data like timezones offsets and locale aware date formats giving you a simple API to format, parse, and manipulates dates.
 
-Tempo is tiny tree-shakable framework, you can only take what you need. All functionality is available in **5.1 kB for esm** and **5.4 kB for cjs** modules (minified and brotlied). [Size Limit](https://github.com/ai/size-limit) controls the size.
+Tempo is tiny tree-shakable framework, you can only take what you need. All functionality is available in **5.2 kB for esm** and **5.5 kB for cjs** modules (minified and brotlied). [Size Limit](https://github.com/ai/size-limit) controls the size.
 
 <a href="https://tempo.formkit.com">
 <img src="docs/public/read-the-docs.png" alt="Read the docs" width="200" height="43">

docs/components/content/Introduction.vue

@@ -6,16 +6,17 @@
     <p>
       Tempo is a new library in a proud tradition of JavaScript date and time
       libraries. Inspired by the likes of moment.js, day.js, and date-fns, Tempo
-      is built from the ground up to be as small and easy to use as possible —
-      including first-class support for timezone operations.
+      is built from the ground up to be as small and easy to use as possible
+      (all features ~5kB compressed) — including first-class support for
+      timezone operations.
     </p>
     <p>
       Tempo is best thought of as a collection of utilities for working with the
       native <code>Date</code> object — an important distinction from other
       libraries that provide custom date primitives. Under the hood, Tempo mines
       JavaScript's <code>Intl.DateTimeFormat</code> to extract complex data like
-      timezones offsets and locale aware date formats, giving you a simple API to
-      format, parse, and manipulate dates.
+      timezones offsets and locale aware date formats, giving you a simple API
+      to format, parse, and manipulate dates.
     </p>
 
     <CodeExample file="introduction" />

src/__tests__/date.spec.ts

@@ -12,5 +12,8 @@ describe("date", () => {
     expect(date("2022-01-22T00:00-0300").toISOString()).toBe(
       "2022-01-22T03:00:00.000Z"
     )
+    expect(date("2022-01-22T00:00-03:24").toISOString()).toBe(
+      "2022-01-22T03:24:00.000Z"
+    )
   })
 })

src/__tests__/parse.spec.ts

@@ -84,6 +84,14 @@ describe("parse", () => {
       }:22:00.000Z`
     )
   })
+  it("can parse [+-]HH:mm", () => {
+    expect(
+      parse("1994-06-22T04:22:32+09:00", "YYYY-MM-DDTHH:mm:ssZ").toISOString()
+    ).toBe("1994-06-21T19:22:32.000Z")
+    expect(
+      parse("1994-06-22T04:22:32+09:00").toISOString()
+    ).toBe("1994-06-21T19:22:32.000Z")
+  })
   it("can parse the string month in en", () => {
     let h: number | string = new Date("2019-01-01").getTimezoneOffset() / 60
     h = h < 10 ? `0${h}` : h

src/__tests__/validOffset.spec.ts

@@ -6,5 +6,7 @@ describe("validOffset", () => {
   it("returns its own value when valid", () => {
     expect(validOffset("+0000")).toBe("+0000")
     expect(validOffset("+0100")).toBe("+0100")
+    expect(validOffset("+00:00")).toBe("+00:00")
+    expect(validOffset("+01:00")).toBe("+01:00")
   })
 })

src/common.ts

@@ -71,7 +71,23 @@ export const fixedLength = {
   hh: 2,
   mm: 2,
   ss: 2,
-  Z: 5,
+}
+
+/**
+ * token Z can have variable length depending on the actual value, so it's
+ */
+export function fixedLengthByOffset(offsetString: string): number {
+  // starts with [+-]xx:xx
+  if (/^[+-]\d{2}:\d{2}/.test(offsetString)) {
+    return 6
+  }
+
+  // starts with [+-]xxxx
+  if (/^[+-]\d{4}/.test(offsetString)) {
+    return 5
+  }
+
+  throw new Error("Invalid offset format")
 }
 
 /**
@@ -297,11 +313,11 @@ export function offsetToMins(offset: string): number {
 
 /**
  * Validates that an offset is valid according to the format:
- * [+-]HHmm
+ * [+-]HHmm or [+-]HH:mm
  * @param offset - The offset to validate.
  */
 export function validOffset(offset: string) {
-  const valid = /^([+-])[0-3][0-9][0-6][0-9]$/.test(offset)
+  const valid = /^([+-])[0-3][0-9]:?[0-6][0-9]$/.test(offset)
   if (!valid) throw new Error(`Invalid offset: ${offset}`)
   return offset
 }

src/iso8601.ts

@@ -4,7 +4,7 @@
  * specificity.
  */
 export const iso8601Match =
-  /^([0-9]{4})-([0-1][0-9])(?:-([0-3][0-9]))?(?:[T ]?([0-2][0-9])(?::([0-5][0-9]))?(?::([0-5][0-9]))?)?(?:\.[0-9]+)?(Z|(?:\+|\-)[0-9]{4})?$/
+  /^([0-9]{4})-([0-1][0-9])(?:-([0-3][0-9]))?(?:[T ]?([0-2][0-9])(?::([0-5][0-9]))?(?::([0-5][0-9]))?)?(?:\.[0-9]+)?(Z|(?:\+|\-)[0-9]{2}:?[0-9]{2})?$/
 
 /**
  * True when the date string is valid ISO 8601.

src/parse.ts

@@ -1,5 +1,5 @@
 import { date } from "./date"
-import { validate, styles, fixedLength, four, two, validOffset } from "./common"
+import { validate, styles, fixedLength, four, two, validOffset, fixedLengthByOffset } from "./common"
 import { formatStr } from "./formatStr"
 import { fourDigitYear } from "./fourDigitYear"
 import { ap } from "./ap"
@@ -172,6 +172,8 @@ export function parseParts(dateStr: string, formatParts: Part[]): FilledPart[] {
     if (current.partName === "literal") {
       // Literals can be discarded
       len = current.partValue.length
+    } else if (current.partName === "timeZoneName") {
+      len = fixedLengthByOffset(dateStr.substring(pos))
     } else if (current.token in fixedLength) {
       // Fixed length parse
       len = fixedLength[current.token as keyof typeof fixedLength]