@northguild/gmt 1.14.2 → 1.16.0

package/dist/zoned/validate/isValidZonedRange.js

@@ -1,14 +1,21 @@
+// fallow-ignore-file code-duplication -- cross-family Temporal type clone, by design (rule 5)
 import { Temporal } from "@js-temporal/polyfill";
 import { isLeapSecond } from "../../plain/validate/isLeapSecond.js";
+import { isObject, isOptionsArgument, zonedDateTimeFrom } from "../../internal/index.js";
+import { hasZonedDateTimeShape } from "../../internal/isoStringBody.js";
 /**
  * Return true if `value1` and `value2` form a valid zoned range — both parseable as
  * ISO ZonedDateTime strings and the instant at `value1` is <= the instant at `value2`.
  *
- * - Both inputs must be valid ISO 8601 zoned datetime strings.
+ * - Both inputs must be valid ISO 8601 zoned datetime strings in extended format, as
+ *   `isValidZonedDateTime` requires: basic format, a space or lower-case `t` separator, a
+ *   lower-case `z` and a date without a time return `false`.
  * - Equal `value1 === value2` is valid when `options.allowEqual` is true.
  * - Comparison is done by instant, so intervals spanning DST transitions are compared
  *   by absolute time.
  * - Invalid input, malformed strings, or leap-second strings return `false`.
+ * - Annotations are read as `isValidZonedDateTime` reads them: elective ones are ignored,
+ *   `[u-ca=iso8601]` is accepted, and a non-ISO calendar on either endpoint returns `false`.
  *
  * @param value1 first ISO ZonedDateTime string
  * @param value2 second ISO ZonedDateTime string
@@ -18,26 +25,47 @@ import { isLeapSecond } from "../../plain/validate/isLeapSecond.js";
  * @example isValidZonedRange({ value1: "2024-01-01T10:00:00+00:00[UTC]", value2: "2024-12-31T23:59:59+00:00[UTC]" }) // true
  * @example isValidZonedRange({ value1: "2024-12-31T23:59:59+00:00[UTC]", value2: "2024-01-01T10:00:00+00:00[UTC]" }) // false
  * @example isValidZonedRange({ value1: "2024-06-15T12:00:00-04:00[America/New_York]", value2: "2024-06-15T12:00:00-04:00[America/New_York]", options: { allowEqual: true } }) // true
+ * @example isValidZonedRange({ value1: "2024-01-01T00:00:00+00:00[UTC][u-ca=hebrew]", value2: "2024-02-01T00:00:00+00:00[UTC]" }) // false (non-ISO calendar)
+ * @example isValidZonedRange({ value1: "2024-01-01T00:00:00+00:00[UTC][u-ca=iso8601]", value2: "2024-02-01T00:00:00+00:00[UTC]" }) // true
+ * @example isValidZonedRange({ value1: "2024-01-01 10:00:00+00:00[UTC]", value2: "2024-12-31T23:59:59+00:00[UTC]" }) // false (space separator)
  */
-export function isValidZonedRange({ value1, value2, options, }) {
-    if (typeof value1 !== "string" || typeof value2 !== "string") {
-        return false;
-    }
-    if (isLeapSecond(value1) || isLeapSecond(value2)) {
-        return false;
-    }
+export function isValidZonedRange(props) {
     try {
-        const zdt1 = Temporal.ZonedDateTime.from(value1);
-        const zdt2 = Temporal.ZonedDateTime.from(value2);
-        const instant1 = zdt1.toInstant();
-        const instant2 = zdt2.toInstant();
-        const cmp = Temporal.Instant.compare(instant1, instant2);
-        if (options?.allowEqual) {
-            return cmp <= 0;
+        if (!isObject(props))
+            return false;
+        const { value1, value2, options } = props;
+        if (!isOptionsArgument(options))
+            return false;
+        if (typeof value1 !== "string" || typeof value2 !== "string") {
+            return false;
+        }
+        if (isLeapSecond(value1) ||
+            isLeapSecond(value2) ||
+            !hasZonedDateTimeShape(value1) ||
+            !hasZonedDateTimeShape(value2)) {
+            return false;
+        }
+        try {
+            const zdt1 = zonedDateTimeFrom(value1);
+            const zdt2 = zonedDateTimeFrom(value2);
+            if (zdt1.calendarId !== "iso8601" || zdt2.calendarId !== "iso8601") {
+                return false;
+            }
+            const instant1 = zdt1.toInstant();
+            const instant2 = zdt2.toInstant();
+            const cmp = Temporal.Instant.compare(instant1, instant2);
+            if (options?.allowEqual) {
+                return cmp <= 0;
+            }
+            return cmp < 0;
+        }
+        catch {
+            return false;
         }
-        return cmp < 0;
     }
     catch {
+        // Never throws (Core Rule 3): a hostile
+        // argument is invalid input, not an exception.
         return false;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@northguild/gmt",
-  "version": "1.14.2",
+  "version": "1.16.0",
   "description": "Temporal-based date and time utilities with timezone support and polyfill integration",
   "keywords": [
     "date",
@@ -11,7 +11,7 @@
     "time",
     "timezone"
   ],
-  "homepage": "https://github.com/northguild/gmt#readme",
+  "homepage": "https://gmt-dox.northguild.workers.dev",
   "bugs": {
     "url": "https://github.com/northguild/gmt/issues"
   },
@@ -34,60 +34,515 @@
   "files": [
     "dist",
     "LICENSE",
-    "skills"
+    "README.md",
+    "skills/gmt-basics",
+    "skills/gmt-arithmetic",
+    "skills/gmt-timezone",
+    "skills/gmt-integration"
   ],
   "type": "module",
+  "sideEffects": false,
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "calendar": [
+        "./dist/calendar/index.d.ts"
+      ],
+      "calendar/business": [
+        "./dist/calendar/business/index.d.ts"
+      ],
+      "calendar/calculate": [
+        "./dist/calendar/calculate/index.d.ts"
+      ],
+      "calendar/validate": [
+        "./dist/calendar/validate/index.d.ts"
+      ],
+      "duration": [
+        "./dist/duration/index.d.ts"
+      ],
+      "duration/calculate": [
+        "./dist/duration/calculate/index.d.ts"
+      ],
+      "duration/compare": [
+        "./dist/duration/compare/index.d.ts"
+      ],
+      "duration/format": [
+        "./dist/duration/format/index.d.ts"
+      ],
+      "duration/normalize": [
+        "./dist/duration/normalize/index.d.ts"
+      ],
+      "duration/parse": [
+        "./dist/duration/parse/index.d.ts"
+      ],
+      "duration/validate": [
+        "./dist/duration/validate/index.d.ts"
+      ],
+      "instant": [
+        "./dist/instant/index.d.ts"
+      ],
+      "instant/convert": [
+        "./dist/instant/convert/index.d.ts"
+      ],
+      "interval": [
+        "./dist/interval/index.d.ts"
+      ],
+      "interval/calculate": [
+        "./dist/interval/calculate/index.d.ts"
+      ],
+      "interval/compare": [
+        "./dist/interval/compare/index.d.ts"
+      ],
+      "interval/validate": [
+        "./dist/interval/validate/index.d.ts"
+      ],
+      "plain": [
+        "./dist/plain/index.d.ts"
+      ],
+      "plain/calculate": [
+        "./dist/plain/calculate/index.d.ts"
+      ],
+      "plain/chop": [
+        "./dist/plain/chop/index.d.ts"
+      ],
+      "plain/compare": [
+        "./dist/plain/compare/index.d.ts"
+      ],
+      "plain/convert": [
+        "./dist/plain/convert/index.d.ts"
+      ],
+      "plain/format": [
+        "./dist/plain/format/index.d.ts"
+      ],
+      "plain/get": [
+        "./dist/plain/get/index.d.ts"
+      ],
+      "plain/interval": [
+        "./dist/plain/interval/index.d.ts"
+      ],
+      "plain/locale": [
+        "./dist/plain/locale/index.d.ts"
+      ],
+      "plain/map": [
+        "./dist/plain/map/index.d.ts"
+      ],
+      "plain/parse": [
+        "./dist/plain/parse/index.d.ts"
+      ],
+      "plain/validate": [
+        "./dist/plain/validate/index.d.ts"
+      ],
+      "precision": [
+        "./dist/precision/index.d.ts"
+      ],
+      "precision/calculate": [
+        "./dist/precision/calculate/index.d.ts"
+      ],
+      "precision/convert": [
+        "./dist/precision/convert/index.d.ts"
+      ],
+      "precision/format": [
+        "./dist/precision/format/index.d.ts"
+      ],
+      "precision/parse": [
+        "./dist/precision/parse/index.d.ts"
+      ],
+      "precision/validate": [
+        "./dist/precision/validate/index.d.ts"
+      ],
+      "regex": [
+        "./dist/regex/index.d.ts"
+      ],
+      "span": [
+        "./dist/span/index.d.ts"
+      ],
+      "span/calculate": [
+        "./dist/span/calculate/index.d.ts"
+      ],
+      "span/validate": [
+        "./dist/span/validate/index.d.ts"
+      ],
+      "types": [
+        "./dist/types/index.d.ts"
+      ],
+      "unix": [
+        "./dist/unix/index.d.ts"
+      ],
+      "unix/calculate": [
+        "./dist/unix/calculate/index.d.ts"
+      ],
+      "unix/compare": [
+        "./dist/unix/compare/index.d.ts"
+      ],
+      "unix/convert": [
+        "./dist/unix/convert/index.d.ts"
+      ],
+      "unix/format": [
+        "./dist/unix/format/index.d.ts"
+      ],
+      "unix/get": [
+        "./dist/unix/get/index.d.ts"
+      ],
+      "unix/interval": [
+        "./dist/unix/interval/index.d.ts"
+      ],
+      "unix/parse": [
+        "./dist/unix/parse/index.d.ts"
+      ],
+      "unix/validate": [
+        "./dist/unix/validate/index.d.ts"
+      ],
+      "utc": [
+        "./dist/utc/index.d.ts"
+      ],
+      "utc/calculate": [
+        "./dist/utc/calculate/index.d.ts"
+      ],
+      "utc/chop": [
+        "./dist/utc/chop/index.d.ts"
+      ],
+      "utc/compare": [
+        "./dist/utc/compare/index.d.ts"
+      ],
+      "utc/convert": [
+        "./dist/utc/convert/index.d.ts"
+      ],
+      "utc/format": [
+        "./dist/utc/format/index.d.ts"
+      ],
+      "utc/get": [
+        "./dist/utc/get/index.d.ts"
+      ],
+      "utc/interval": [
+        "./dist/utc/interval/index.d.ts"
+      ],
+      "utc/parse": [
+        "./dist/utc/parse/index.d.ts"
+      ],
+      "utc/validate": [
+        "./dist/utc/validate/index.d.ts"
+      ],
+      "zoned": [
+        "./dist/zoned/index.d.ts"
+      ],
+      "zoned/calculate": [
+        "./dist/zoned/calculate/index.d.ts"
+      ],
+      "zoned/chop": [
+        "./dist/zoned/chop/index.d.ts"
+      ],
+      "zoned/compare": [
+        "./dist/zoned/compare/index.d.ts"
+      ],
+      "zoned/convert": [
+        "./dist/zoned/convert/index.d.ts"
+      ],
+      "zoned/format": [
+        "./dist/zoned/format/index.d.ts"
+      ],
+      "zoned/get": [
+        "./dist/zoned/get/index.d.ts"
+      ],
+      "zoned/interval": [
+        "./dist/zoned/interval/index.d.ts"
+      ],
+      "zoned/map": [
+        "./dist/zoned/map/index.d.ts"
+      ],
+      "zoned/parse": [
+        "./dist/zoned/parse/index.d.ts"
+      ],
+      "zoned/validate": [
+        "./dist/zoned/validate/index.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./calendar": {
+      "types": "./dist/calendar/index.d.ts",
+      "default": "./dist/calendar/index.js"
+    },
+    "./calendar/business": {
+      "types": "./dist/calendar/business/index.d.ts",
+      "default": "./dist/calendar/business/index.js"
+    },
+    "./calendar/calculate": {
+      "types": "./dist/calendar/calculate/index.d.ts",
+      "default": "./dist/calendar/calculate/index.js"
+    },
+    "./calendar/validate": {
+      "types": "./dist/calendar/validate/index.d.ts",
+      "default": "./dist/calendar/validate/index.js"
+    },
+    "./duration": {
+      "types": "./dist/duration/index.d.ts",
+      "default": "./dist/duration/index.js"
+    },
+    "./duration/calculate": {
+      "types": "./dist/duration/calculate/index.d.ts",
+      "default": "./dist/duration/calculate/index.js"
+    },
+    "./duration/compare": {
+      "types": "./dist/duration/compare/index.d.ts",
+      "default": "./dist/duration/compare/index.js"
+    },
+    "./duration/format": {
+      "types": "./dist/duration/format/index.d.ts",
+      "default": "./dist/duration/format/index.js"
+    },
+    "./duration/normalize": {
+      "types": "./dist/duration/normalize/index.d.ts",
+      "default": "./dist/duration/normalize/index.js"
+    },
+    "./duration/parse": {
+      "types": "./dist/duration/parse/index.d.ts",
+      "default": "./dist/duration/parse/index.js"
+    },
+    "./duration/validate": {
+      "types": "./dist/duration/validate/index.d.ts",
+      "default": "./dist/duration/validate/index.js"
+    },
+    "./instant": {
+      "types": "./dist/instant/index.d.ts",
+      "default": "./dist/instant/index.js"
+    },
+    "./instant/convert": {
+      "types": "./dist/instant/convert/index.d.ts",
+      "default": "./dist/instant/convert/index.js"
+    },
+    "./interval": {
+      "types": "./dist/interval/index.d.ts",
+      "default": "./dist/interval/index.js"
+    },
+    "./interval/calculate": {
+      "types": "./dist/interval/calculate/index.d.ts",
+      "default": "./dist/interval/calculate/index.js"
+    },
+    "./interval/compare": {
+      "types": "./dist/interval/compare/index.d.ts",
+      "default": "./dist/interval/compare/index.js"
+    },
+    "./interval/validate": {
+      "types": "./dist/interval/validate/index.d.ts",
+      "default": "./dist/interval/validate/index.js"
+    },
     "./plain": {
       "types": "./dist/plain/index.d.ts",
       "default": "./dist/plain/index.js"
     },
-    "./plain/*": {
-      "types": "./dist/plain/*/index.d.ts",
-      "default": "./dist/plain/*/index.js"
+    "./plain/calculate": {
+      "types": "./dist/plain/calculate/index.d.ts",
+      "default": "./dist/plain/calculate/index.js"
     },
-    "./plain/*/*": null,
-    "./zoned": {
-      "types": "./dist/zoned/index.d.ts",
-      "default": "./dist/zoned/index.js"
+    "./plain/chop": {
+      "types": "./dist/plain/chop/index.d.ts",
+      "default": "./dist/plain/chop/index.js"
+    },
+    "./plain/compare": {
+      "types": "./dist/plain/compare/index.d.ts",
+      "default": "./dist/plain/compare/index.js"
+    },
+    "./plain/convert": {
+      "types": "./dist/plain/convert/index.d.ts",
+      "default": "./dist/plain/convert/index.js"
+    },
+    "./plain/format": {
+      "types": "./dist/plain/format/index.d.ts",
+      "default": "./dist/plain/format/index.js"
+    },
+    "./plain/get": {
+      "types": "./dist/plain/get/index.d.ts",
+      "default": "./dist/plain/get/index.js"
+    },
+    "./plain/interval": {
+      "types": "./dist/plain/interval/index.d.ts",
+      "default": "./dist/plain/interval/index.js"
+    },
+    "./plain/locale": {
+      "types": "./dist/plain/locale/index.d.ts",
+      "default": "./dist/plain/locale/index.js"
+    },
+    "./plain/map": {
+      "types": "./dist/plain/map/index.d.ts",
+      "default": "./dist/plain/map/index.js"
+    },
+    "./plain/parse": {
+      "types": "./dist/plain/parse/index.d.ts",
+      "default": "./dist/plain/parse/index.js"
+    },
+    "./plain/validate": {
+      "types": "./dist/plain/validate/index.d.ts",
+      "default": "./dist/plain/validate/index.js"
+    },
+    "./precision": {
+      "types": "./dist/precision/index.d.ts",
+      "default": "./dist/precision/index.js"
+    },
+    "./precision/calculate": {
+      "types": "./dist/precision/calculate/index.d.ts",
+      "default": "./dist/precision/calculate/index.js"
+    },
+    "./precision/convert": {
+      "types": "./dist/precision/convert/index.d.ts",
+      "default": "./dist/precision/convert/index.js"
+    },
+    "./precision/format": {
+      "types": "./dist/precision/format/index.d.ts",
+      "default": "./dist/precision/format/index.js"
     },
-    "./zoned/*": {
-      "types": "./dist/zoned/*/index.d.ts",
-      "default": "./dist/zoned/*/index.js"
+    "./precision/parse": {
+      "types": "./dist/precision/parse/index.d.ts",
+      "default": "./dist/precision/parse/index.js"
+    },
+    "./precision/validate": {
+      "types": "./dist/precision/validate/index.d.ts",
+      "default": "./dist/precision/validate/index.js"
     },
-    "./zoned/*/*": null,
     "./regex": {
       "types": "./dist/regex/index.d.ts",
       "default": "./dist/regex/index.js"
     },
-    "./regex/*": {
-      "types": "./dist/regex/*.d.ts",
-      "default": "./dist/regex/*.js"
+    "./span": {
+      "types": "./dist/span/index.d.ts",
+      "default": "./dist/span/index.js"
+    },
+    "./span/calculate": {
+      "types": "./dist/span/calculate/index.d.ts",
+      "default": "./dist/span/calculate/index.js"
+    },
+    "./span/validate": {
+      "types": "./dist/span/validate/index.d.ts",
+      "default": "./dist/span/validate/index.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/types/index.js"
     },
     "./unix": {
       "types": "./dist/unix/index.d.ts",
       "default": "./dist/unix/index.js"
     },
-    "./unix/*": {
-      "types": "./dist/unix/*/index.d.ts",
-      "default": "./dist/unix/*/index.js"
+    "./unix/calculate": {
+      "types": "./dist/unix/calculate/index.d.ts",
+      "default": "./dist/unix/calculate/index.js"
+    },
+    "./unix/compare": {
+      "types": "./dist/unix/compare/index.d.ts",
+      "default": "./dist/unix/compare/index.js"
+    },
+    "./unix/convert": {
+      "types": "./dist/unix/convert/index.d.ts",
+      "default": "./dist/unix/convert/index.js"
+    },
+    "./unix/format": {
+      "types": "./dist/unix/format/index.d.ts",
+      "default": "./dist/unix/format/index.js"
+    },
+    "./unix/get": {
+      "types": "./dist/unix/get/index.d.ts",
+      "default": "./dist/unix/get/index.js"
+    },
+    "./unix/interval": {
+      "types": "./dist/unix/interval/index.d.ts",
+      "default": "./dist/unix/interval/index.js"
+    },
+    "./unix/parse": {
+      "types": "./dist/unix/parse/index.d.ts",
+      "default": "./dist/unix/parse/index.js"
+    },
+    "./unix/validate": {
+      "types": "./dist/unix/validate/index.d.ts",
+      "default": "./dist/unix/validate/index.js"
     },
-    "./unix/*/*": null,
     "./utc": {
       "types": "./dist/utc/index.d.ts",
       "default": "./dist/utc/index.js"
     },
-    "./utc/*": {
-      "types": "./dist/utc/*/index.d.ts",
-      "default": "./dist/utc/*/index.js"
+    "./utc/calculate": {
+      "types": "./dist/utc/calculate/index.d.ts",
+      "default": "./dist/utc/calculate/index.js"
+    },
+    "./utc/chop": {
+      "types": "./dist/utc/chop/index.d.ts",
+      "default": "./dist/utc/chop/index.js"
+    },
+    "./utc/compare": {
+      "types": "./dist/utc/compare/index.d.ts",
+      "default": "./dist/utc/compare/index.js"
+    },
+    "./utc/convert": {
+      "types": "./dist/utc/convert/index.d.ts",
+      "default": "./dist/utc/convert/index.js"
+    },
+    "./utc/format": {
+      "types": "./dist/utc/format/index.d.ts",
+      "default": "./dist/utc/format/index.js"
+    },
+    "./utc/get": {
+      "types": "./dist/utc/get/index.d.ts",
+      "default": "./dist/utc/get/index.js"
+    },
+    "./utc/interval": {
+      "types": "./dist/utc/interval/index.d.ts",
+      "default": "./dist/utc/interval/index.js"
     },
-    "./utc/*/*": null
+    "./utc/parse": {
+      "types": "./dist/utc/parse/index.d.ts",
+      "default": "./dist/utc/parse/index.js"
+    },
+    "./utc/validate": {
+      "types": "./dist/utc/validate/index.d.ts",
+      "default": "./dist/utc/validate/index.js"
+    },
+    "./zoned": {
+      "types": "./dist/zoned/index.d.ts",
+      "default": "./dist/zoned/index.js"
+    },
+    "./zoned/calculate": {
+      "types": "./dist/zoned/calculate/index.d.ts",
+      "default": "./dist/zoned/calculate/index.js"
+    },
+    "./zoned/chop": {
+      "types": "./dist/zoned/chop/index.d.ts",
+      "default": "./dist/zoned/chop/index.js"
+    },
+    "./zoned/compare": {
+      "types": "./dist/zoned/compare/index.d.ts",
+      "default": "./dist/zoned/compare/index.js"
+    },
+    "./zoned/convert": {
+      "types": "./dist/zoned/convert/index.d.ts",
+      "default": "./dist/zoned/convert/index.js"
+    },
+    "./zoned/format": {
+      "types": "./dist/zoned/format/index.d.ts",
+      "default": "./dist/zoned/format/index.js"
+    },
+    "./zoned/get": {
+      "types": "./dist/zoned/get/index.d.ts",
+      "default": "./dist/zoned/get/index.js"
+    },
+    "./zoned/interval": {
+      "types": "./dist/zoned/interval/index.d.ts",
+      "default": "./dist/zoned/interval/index.js"
+    },
+    "./zoned/map": {
+      "types": "./dist/zoned/map/index.d.ts",
+      "default": "./dist/zoned/map/index.js"
+    },
+    "./zoned/parse": {
+      "types": "./dist/zoned/parse/index.d.ts",
+      "default": "./dist/zoned/parse/index.js"
+    },
+    "./zoned/validate": {
+      "types": "./dist/zoned/validate/index.d.ts",
+      "default": "./dist/zoned/validate/index.js"
+    }
   },
   "publishConfig": {
     "access": "public",
@@ -97,13 +552,17 @@
     "@js-temporal/polyfill": "^0.5.1"
   },
   "devDependencies": {
-    "@tanstack/intent": "^0.3.6",
+    "@tanstack/intent": "^0.4.0",
     "oxfmt": "^0.62.0",
-    "oxlint": "^1.0.0",
-    "@northguild/gmt-oxlint": "1.1.5"
+    "oxlint": "^1.78.0",
+    "@northguild/gmt-oxlint": "1.2.1"
+  },
+  "engines": {
+    "node": ">=22.16.0"
   },
   "scripts": {
     "build": "rm -rf dist && tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json --resolve-full-paths --resolve-full-extension .js",
+    "build:dev": "test -f dist/index.js || rm -f node_modules/.cache/tsbuildinfo/build.tsbuildinfo; tsc --project tsconfig.build.json --incremental --tsBuildInfoFile node_modules/.cache/tsbuildinfo/build.tsbuildinfo && tsc-alias -p tsconfig.build.json --resolve-full-paths --resolve-full-extension .js",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
     "test:watch": "vitest",