Add support for Temporal objects (#98)

* Add support for Temporal objects

* conditionally import polyfill

* prettier

* changeset

---------

Co-authored-by: Rich Harris <[email protected]>
Co-authored-by: Rich Harris <[email protected]>

Author: nicolo-ribaudo

.changeset/blue-groups-beam.md

@@ -0,0 +1,5 @@
+---
+'devalue': minor
+---
+
+feat: support Temporal

package.json

@@ -19,6 +19,7 @@
 	"types": "./types/index.d.ts",
 	"devDependencies": {
 		"@changesets/cli": "^2.29.6",
+		"@js-temporal/polyfill": "^0.5.1",
 		"dts-buddy": "^0.6.2",
 		"publint": "^0.3.12",
 		"typescript": "^5.9.2",

pnpm-lock.yaml

@@ -131,6 +131,20 @@ export function unflatten(parsed, revivers) {
 						break;
 					}
 
+					case 'Temporal.Duration':
+					case 'Temporal.Instant':
+					case 'Temporal.PlainDate':
+					case 'Temporal.PlainTime':
+					case 'Temporal.PlainDateTime':
+					case 'Temporal.PlainMonthDay':
+					case 'Temporal.PlainYearMonth':
+					case 'Temporal.ZonedDateTime': {
+						const temporalName = type.slice(9);
+						// @ts-expect-error TS doesn't know about Temporal yet
+						hydrated[index] = Temporal[temporalName].from(value[1]);
+						break;
+					}
+
 					default:
 						throw new Error(`Unknown type ${type}`);
 				}

src/parse.js

@@ -177,6 +177,17 @@ export function stringify(value, reducers) {
 					break;
 				}
 
+				case 'Temporal.Duration':
+				case 'Temporal.Instant':
+				case 'Temporal.PlainDate':
+				case 'Temporal.PlainTime':
+				case 'Temporal.PlainDateTime':
+				case 'Temporal.PlainMonthDay':
+				case 'Temporal.PlainYearMonth':
+				case 'Temporal.ZonedDateTime':
+					str = `["${type}",${stringify_string(thing.toString())}]`;
+					break;
+
 				default:
 					if (!is_plain_object(thing)) {
 						throw new DevalueError(

src/stringify.js

@@ -100,6 +100,16 @@ export function uneval(value, replacer) {
 				case 'ArrayBuffer':
 					return;
 
+				case 'Temporal.Duration':
+				case 'Temporal.Instant':
+				case 'Temporal.PlainDate':
+				case 'Temporal.PlainTime':
+				case 'Temporal.PlainDateTime':
+				case 'Temporal.PlainMonthDay':
+				case 'Temporal.PlainYearMonth':
+				case 'Temporal.ZonedDateTime':
+					return;
+
 				default:
 					if (!is_plain_object(thing)) {
 						throw new DevalueError(
@@ -216,6 +226,16 @@ export function uneval(value, replacer) {
 				return `new Uint8Array([${ui8.toString()}]).buffer`;
 			}
 
+			case 'Temporal.Duration':
+			case 'Temporal.Instant':
+			case 'Temporal.PlainDate':
+			case 'Temporal.PlainTime':
+			case 'Temporal.PlainDateTime':
+			case 'Temporal.PlainMonthDay':
+			case 'Temporal.PlainYearMonth':
+			case 'Temporal.ZonedDateTime':
+				return `${type}.from(${stringify_string(thing.toString())})`;
+
 			default:
 				const obj = `{${Object.keys(thing)
 					.map((key) => `${safe_key(key)}:${stringify(thing[key])}`)

src/uneval.js

@@ -3,6 +3,8 @@ import * as assert from 'uvu/assert';
 import * as uvu from 'uvu';
 import { uneval, unflatten, parse, stringify } from '../index.js';
 
+globalThis.Temporal ??= (await import('@js-temporal/polyfill')).Temporal;
+
 class Custom {
 	constructor(value) {
 		this.value = value;
@@ -183,6 +185,69 @@ const fixtures = {
 			value: new Uint16Array([10, 20, 30, 40]).subarray(1, 3),
 			js: 'new Uint16Array([10,20,30,40]).subarray(1,3)',
 			json: '[["Uint16Array",1,1,3],["ArrayBuffer","CgAUAB4AKAA="]]'
+		},
+		{
+			name: 'Temporal.Duration',
+			value: Temporal.Duration.from({ years: 1, months: 2, days: 3 }),
+			js: 'Temporal.Duration.from("P1Y2M3D")',
+			json: '[["Temporal.Duration","P1Y2M3D"]]'
+		},
+		{
+			name: 'Temporal.Instant',
+			value: Temporal.Instant.from('1999-09-29T05:30:00Z'),
+			js: 'Temporal.Instant.from("1999-09-29T05:30:00Z")',
+			json: '[["Temporal.Instant","1999-09-29T05:30:00Z"]]'
+		},
+		{
+			name: 'Temporal.PlainDate',
+			value: Temporal.PlainDate.from({ year: 1999, month: 9, day: 29 }),
+			js: 'Temporal.PlainDate.from("1999-09-29")',
+			json: '[["Temporal.PlainDate","1999-09-29"]]'
+		},
+		{
+			name: 'Temporal.PlainTime',
+			value: Temporal.PlainTime.from({ hour: 12, minute: 34, second: 56 }),
+			js: 'Temporal.PlainTime.from("12:34:56")',
+			json: '[["Temporal.PlainTime","12:34:56"]]'
+		},
+		{
+			name: 'Temporal.PlainDateTime',
+			value: Temporal.PlainDateTime.from({
+				year: 1999,
+				month: 9,
+				day: 29,
+				hour: 12,
+				minute: 34,
+				second: 56
+			}),
+			js: 'Temporal.PlainDateTime.from("1999-09-29T12:34:56")',
+			json: '[["Temporal.PlainDateTime","1999-09-29T12:34:56"]]'
+		},
+		{
+			name: 'Temporal.PlainMonthDay',
+			value: Temporal.PlainMonthDay.from({ month: 9, day: 29 }),
+			js: 'Temporal.PlainMonthDay.from("09-29")',
+			json: '[["Temporal.PlainMonthDay","09-29"]]'
+		},
+		{
+			name: 'Temporal.PlainYearMonth',
+			value: Temporal.PlainYearMonth.from({ year: 1999, month: 9 }),
+			js: 'Temporal.PlainYearMonth.from("1999-09")',
+			json: '[["Temporal.PlainYearMonth","1999-09"]]'
+		},
+		{
+			name: 'Temporal.ZonedDateTime',
+			value: Temporal.ZonedDateTime.from({
+				year: 1999,
+				month: 9,
+				day: 29,
+				hour: 12,
+				minute: 34,
+				second: 56,
+				timeZone: 'Europe/Rome'
+			}),
+			js: 'Temporal.ZonedDateTime.from("1999-09-29T12:34:56+02:00[Europe/Rome]")',
+			json: '[["Temporal.ZonedDateTime","1999-09-29T12:34:56+02:00[Europe/Rome]"]]'
 		}
 	],