@optique/temporal 1.0.0-dev.788 → 1.0.0-dev.886

package/dist/index.cjs

@@ -26,6 +26,9 @@ const __optique_core_message = __toESM(require("@optique/core/message"));
 const __optique_core_nonempty = __toESM(require("@optique/core/nonempty"));
 
 //#region src/index.ts
+function ensureTemporal() {
+	if (typeof globalThis.Temporal === "undefined") throw new TypeError("Temporal API is not available. Use a runtime with Temporal support or install a polyfill like @js-temporal/polyfill.");
+}
 /**
 * Creates a ValueParser for parsing Temporal.Instant from ISO 8601 strings.
 *
@@ -36,6 +39,8 @@ const __optique_core_nonempty = __toESM(require("@optique/core/nonempty"));
 *
 * @param options Configuration options for the instant parser.
 * @returns A ValueParser that parses strings into Temporal.Instant values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function instant(options = {}) {
 	const metavar = options.metavar ?? "TIMESTAMP";
@@ -44,6 +49,7 @@ function instant(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.Instant.from(input);
 				return {
@@ -73,6 +79,8 @@ function instant(options = {}) {
 *
 * @param options Configuration options for the duration parser.
 * @returns A ValueParser that parses strings into Temporal.Duration values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function duration(options = {}) {
 	const metavar = options.metavar ?? "DURATION";
@@ -81,6 +89,7 @@ function duration(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.Duration.from(input);
 				return {
@@ -109,6 +118,8 @@ function duration(options = {}) {
 *
 * @param options Configuration options for the zoned datetime parser.
 * @returns A ValueParser that parses strings into Temporal.ZonedDateTime values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function zonedDateTime(options = {}) {
 	const metavar = options.metavar ?? "ZONED_DATETIME";
@@ -117,6 +128,7 @@ function zonedDateTime(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.ZonedDateTime.from(input);
 				return {
@@ -145,6 +157,8 @@ function zonedDateTime(options = {}) {
 *
 * @param options Configuration options for the plain date parser.
 * @returns A ValueParser that parses strings into Temporal.PlainDate values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainDate(options = {}) {
 	const metavar = options.metavar ?? "DATE";
@@ -153,6 +167,7 @@ function plainDate(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainDate.from(input);
 				return {
@@ -181,6 +196,8 @@ function plainDate(options = {}) {
 *
 * @param options Configuration options for the plain time parser.
 * @returns A ValueParser that parses strings into Temporal.PlainTime values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainTime(options = {}) {
 	const metavar = options.metavar ?? "TIME";
@@ -189,6 +206,7 @@ function plainTime(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainTime.from(input);
 				return {
@@ -217,6 +235,8 @@ function plainTime(options = {}) {
 *
 * @param options Configuration options for the plain datetime parser.
 * @returns A ValueParser that parses strings into Temporal.PlainDateTime values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainDateTime(options = {}) {
 	const metavar = options.metavar ?? "DATETIME";
@@ -225,6 +245,7 @@ function plainDateTime(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainDateTime.from(input);
 				return {
@@ -253,6 +274,8 @@ function plainDateTime(options = {}) {
 *
 * @param options Configuration options for the plain year-month parser.
 * @returns A ValueParser that parses strings into Temporal.PlainYearMonth values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainYearMonth(options = {}) {
 	const metavar = options.metavar ?? "YEAR-MONTH";
@@ -261,6 +284,7 @@ function plainYearMonth(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainYearMonth.from(input);
 				return {
@@ -289,6 +313,8 @@ function plainYearMonth(options = {}) {
 *
 * @param options Configuration options for the plain month-day parser.
 * @returns A ValueParser that parses strings into Temporal.PlainMonthDay values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainMonthDay(options = {}) {
 	const metavar = options.metavar ?? "--MONTH-DAY";
@@ -297,6 +323,7 @@ function plainMonthDay(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainMonthDay.from(input);
 				return {
@@ -327,6 +354,8 @@ function plainMonthDay(options = {}) {
 *
 * @param options Configuration options for the timezone parser.
 * @returns A ValueParser that parses and validates timezone identifiers.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function timeZone(options = {}) {
 	const metavar = options.metavar ?? "TIMEZONE";
@@ -335,6 +364,7 @@ function timeZone(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				Temporal.ZonedDateTime.from({
 					year: 2020,

package/dist/index.d.cts

@@ -248,6 +248,8 @@ interface TimeZoneOptions {
  *
  * @param options Configuration options for the instant parser.
  * @returns A ValueParser that parses strings into Temporal.Instant values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function instant(options?: InstantOptions): ValueParser<"sync", Temporal.Instant>;
 /**
@@ -261,6 +263,8 @@ declare function instant(options?: InstantOptions): ValueParser<"sync", Temporal
  *
  * @param options Configuration options for the duration parser.
  * @returns A ValueParser that parses strings into Temporal.Duration values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function duration(options?: DurationOptions): ValueParser<"sync", Temporal.Duration>;
 /**
@@ -273,6 +277,8 @@ declare function duration(options?: DurationOptions): ValueParser<"sync", Tempor
  *
  * @param options Configuration options for the zoned datetime parser.
  * @returns A ValueParser that parses strings into Temporal.ZonedDateTime values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function zonedDateTime(options?: ZonedDateTimeOptions): ValueParser<"sync", Temporal.ZonedDateTime>;
 /**
@@ -285,6 +291,8 @@ declare function zonedDateTime(options?: ZonedDateTimeOptions): ValueParser<"syn
  *
  * @param options Configuration options for the plain date parser.
  * @returns A ValueParser that parses strings into Temporal.PlainDate values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainDate(options?: PlainDateOptions): ValueParser<"sync", Temporal.PlainDate>;
 /**
@@ -297,6 +305,8 @@ declare function plainDate(options?: PlainDateOptions): ValueParser<"sync", Temp
  *
  * @param options Configuration options for the plain time parser.
  * @returns A ValueParser that parses strings into Temporal.PlainTime values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainTime(options?: PlainTimeOptions): ValueParser<"sync", Temporal.PlainTime>;
 /**
@@ -309,6 +319,8 @@ declare function plainTime(options?: PlainTimeOptions): ValueParser<"sync", Temp
  *
  * @param options Configuration options for the plain datetime parser.
  * @returns A ValueParser that parses strings into Temporal.PlainDateTime values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainDateTime(options?: PlainDateTimeOptions): ValueParser<"sync", Temporal.PlainDateTime>;
 /**
@@ -321,6 +333,8 @@ declare function plainDateTime(options?: PlainDateTimeOptions): ValueParser<"syn
  *
  * @param options Configuration options for the plain year-month parser.
  * @returns A ValueParser that parses strings into Temporal.PlainYearMonth values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainYearMonth(options?: PlainYearMonthOptions): ValueParser<"sync", Temporal.PlainYearMonth>;
 /**
@@ -333,6 +347,8 @@ declare function plainYearMonth(options?: PlainYearMonthOptions): ValueParser<"s
  *
  * @param options Configuration options for the plain month-day parser.
  * @returns A ValueParser that parses strings into Temporal.PlainMonthDay values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainMonthDay(options?: PlainMonthDayOptions): ValueParser<"sync", Temporal.PlainMonthDay>;
 /**
@@ -347,6 +363,8 @@ declare function plainMonthDay(options?: PlainMonthDayOptions): ValueParser<"syn
  *
  * @param options Configuration options for the timezone parser.
  * @returns A ValueParser that parses and validates timezone identifiers.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function timeZone(options?: TimeZoneOptions): ValueParser<"sync", TimeZone>;
 //#endregion

package/dist/index.d.ts

@@ -249,6 +249,8 @@ interface TimeZoneOptions {
  *
  * @param options Configuration options for the instant parser.
  * @returns A ValueParser that parses strings into Temporal.Instant values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function instant(options?: InstantOptions): ValueParser<"sync", Temporal.Instant>;
 /**
@@ -262,6 +264,8 @@ declare function instant(options?: InstantOptions): ValueParser<"sync", Temporal
  *
  * @param options Configuration options for the duration parser.
  * @returns A ValueParser that parses strings into Temporal.Duration values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function duration(options?: DurationOptions): ValueParser<"sync", Temporal.Duration>;
 /**
@@ -274,6 +278,8 @@ declare function duration(options?: DurationOptions): ValueParser<"sync", Tempor
  *
  * @param options Configuration options for the zoned datetime parser.
  * @returns A ValueParser that parses strings into Temporal.ZonedDateTime values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function zonedDateTime(options?: ZonedDateTimeOptions): ValueParser<"sync", Temporal.ZonedDateTime>;
 /**
@@ -286,6 +292,8 @@ declare function zonedDateTime(options?: ZonedDateTimeOptions): ValueParser<"syn
  *
  * @param options Configuration options for the plain date parser.
  * @returns A ValueParser that parses strings into Temporal.PlainDate values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainDate(options?: PlainDateOptions): ValueParser<"sync", Temporal.PlainDate>;
 /**
@@ -298,6 +306,8 @@ declare function plainDate(options?: PlainDateOptions): ValueParser<"sync", Temp
  *
  * @param options Configuration options for the plain time parser.
  * @returns A ValueParser that parses strings into Temporal.PlainTime values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainTime(options?: PlainTimeOptions): ValueParser<"sync", Temporal.PlainTime>;
 /**
@@ -310,6 +320,8 @@ declare function plainTime(options?: PlainTimeOptions): ValueParser<"sync", Temp
  *
  * @param options Configuration options for the plain datetime parser.
  * @returns A ValueParser that parses strings into Temporal.PlainDateTime values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainDateTime(options?: PlainDateTimeOptions): ValueParser<"sync", Temporal.PlainDateTime>;
 /**
@@ -322,6 +334,8 @@ declare function plainDateTime(options?: PlainDateTimeOptions): ValueParser<"syn
  *
  * @param options Configuration options for the plain year-month parser.
  * @returns A ValueParser that parses strings into Temporal.PlainYearMonth values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainYearMonth(options?: PlainYearMonthOptions): ValueParser<"sync", Temporal.PlainYearMonth>;
 /**
@@ -334,6 +348,8 @@ declare function plainYearMonth(options?: PlainYearMonthOptions): ValueParser<"s
  *
  * @param options Configuration options for the plain month-day parser.
  * @returns A ValueParser that parses strings into Temporal.PlainMonthDay values.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function plainMonthDay(options?: PlainMonthDayOptions): ValueParser<"sync", Temporal.PlainMonthDay>;
 /**
@@ -348,6 +364,8 @@ declare function plainMonthDay(options?: PlainMonthDayOptions): ValueParser<"syn
  *
  * @param options Configuration options for the timezone parser.
  * @returns A ValueParser that parses and validates timezone identifiers.
+ * @throws {TypeError} (from `parse()`) If the Temporal API is not available
+ *   at runtime.
  */
 declare function timeZone(options?: TimeZoneOptions): ValueParser<"sync", TimeZone>;
 //#endregion

package/dist/index.js

@@ -3,6 +3,9 @@ import { message } from "@optique/core/message";
 import { ensureNonEmptyString } from "@optique/core/nonempty";
 
 //#region src/index.ts
+function ensureTemporal() {
+	if (typeof globalThis.Temporal === "undefined") throw new TypeError("Temporal API is not available. Use a runtime with Temporal support or install a polyfill like @js-temporal/polyfill.");
+}
 /**
 * Creates a ValueParser for parsing Temporal.Instant from ISO 8601 strings.
 *
@@ -13,6 +16,8 @@ import { ensureNonEmptyString } from "@optique/core/nonempty";
 *
 * @param options Configuration options for the instant parser.
 * @returns A ValueParser that parses strings into Temporal.Instant values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function instant(options = {}) {
 	const metavar = options.metavar ?? "TIMESTAMP";
@@ -21,6 +26,7 @@ function instant(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.Instant.from(input);
 				return {
@@ -50,6 +56,8 @@ function instant(options = {}) {
 *
 * @param options Configuration options for the duration parser.
 * @returns A ValueParser that parses strings into Temporal.Duration values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function duration(options = {}) {
 	const metavar = options.metavar ?? "DURATION";
@@ -58,6 +66,7 @@ function duration(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.Duration.from(input);
 				return {
@@ -86,6 +95,8 @@ function duration(options = {}) {
 *
 * @param options Configuration options for the zoned datetime parser.
 * @returns A ValueParser that parses strings into Temporal.ZonedDateTime values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function zonedDateTime(options = {}) {
 	const metavar = options.metavar ?? "ZONED_DATETIME";
@@ -94,6 +105,7 @@ function zonedDateTime(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.ZonedDateTime.from(input);
 				return {
@@ -122,6 +134,8 @@ function zonedDateTime(options = {}) {
 *
 * @param options Configuration options for the plain date parser.
 * @returns A ValueParser that parses strings into Temporal.PlainDate values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainDate(options = {}) {
 	const metavar = options.metavar ?? "DATE";
@@ -130,6 +144,7 @@ function plainDate(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainDate.from(input);
 				return {
@@ -158,6 +173,8 @@ function plainDate(options = {}) {
 *
 * @param options Configuration options for the plain time parser.
 * @returns A ValueParser that parses strings into Temporal.PlainTime values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainTime(options = {}) {
 	const metavar = options.metavar ?? "TIME";
@@ -166,6 +183,7 @@ function plainTime(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainTime.from(input);
 				return {
@@ -194,6 +212,8 @@ function plainTime(options = {}) {
 *
 * @param options Configuration options for the plain datetime parser.
 * @returns A ValueParser that parses strings into Temporal.PlainDateTime values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainDateTime(options = {}) {
 	const metavar = options.metavar ?? "DATETIME";
@@ -202,6 +222,7 @@ function plainDateTime(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainDateTime.from(input);
 				return {
@@ -230,6 +251,8 @@ function plainDateTime(options = {}) {
 *
 * @param options Configuration options for the plain year-month parser.
 * @returns A ValueParser that parses strings into Temporal.PlainYearMonth values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainYearMonth(options = {}) {
 	const metavar = options.metavar ?? "YEAR-MONTH";
@@ -238,6 +261,7 @@ function plainYearMonth(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainYearMonth.from(input);
 				return {
@@ -266,6 +290,8 @@ function plainYearMonth(options = {}) {
 *
 * @param options Configuration options for the plain month-day parser.
 * @returns A ValueParser that parses strings into Temporal.PlainMonthDay values.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function plainMonthDay(options = {}) {
 	const metavar = options.metavar ?? "--MONTH-DAY";
@@ -274,6 +300,7 @@ function plainMonthDay(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				const value = Temporal.PlainMonthDay.from(input);
 				return {
@@ -304,6 +331,8 @@ function plainMonthDay(options = {}) {
 *
 * @param options Configuration options for the timezone parser.
 * @returns A ValueParser that parses and validates timezone identifiers.
+* @throws {TypeError} (from `parse()`) If the Temporal API is not available
+*   at runtime.
 */
 function timeZone(options = {}) {
 	const metavar = options.metavar ?? "TIMEZONE";
@@ -312,6 +341,7 @@ function timeZone(options = {}) {
 		$mode: "sync",
 		metavar,
 		parse(input) {
+			ensureTemporal();
 			try {
 				Temporal.ZonedDateTime.from({
 					year: 2020,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/temporal",
-  "version": "1.0.0-dev.788+1f1c275f",
+  "version": "1.0.0-dev.886+4b42a9bd",
   "description": "Temporal value parsers for Optique",
   "keywords": [
     "CLI",
@@ -56,7 +56,7 @@
   "sideEffects": false,
   "dependencies": {
     "@js-temporal/polyfill": "^0.5.1",
-    "@optique/core": "1.0.0-dev.788+1f1c275f"
+    "@optique/core": "1.0.0-dev.886+4b42a9bd"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",