smol-toml 1.7.2 → 1.8.0

package/README.md

@@ -66,7 +66,7 @@ A few notes on the `stringify` function:
 - By default, floats will be serialized as integers if they don't have a decimal part. See [Integers](#integers)
   - `stringify(parse('a = 1.0')) === 'a = 1'`
 - JS `Date` will be serialized as Offset Date Time
-  - Use the [`TomlDate` object](#dates) for representing other types.
+  - Use the [Temporal API] for representing other types (or alternatively the legacy [`TomlDate` object](#dates)).
 
 ### Integers
 When parsing, both integers and floats are read as plain JavaScript numbers, which essentially are floats. This means
@@ -101,8 +101,22 @@ const toml = stringify(obj, { numbersAsFloat: true })
 ```
 
 ### Dates
-`smol-toml` uses an extended `Date` object to represent all types of TOML Dates. In the future, `smol-toml` will use
-objects from the Temporal proposal, but for now we're stuck with the legacy Date object.
+`smol-toml` uses an extended `Date` object to represent all types of TOML Dates. In the future, `smol-toml` will emit
+objects from the Temporal API, but for now it only supports `Date` when parsing. When stringifying, `smol-toml` does
+support objects from the [Temporal API] and will output the appropriate TOML type.
+
+> [!IMPORTANT]
+> If you create a `ZonedDateTime` with a timezone, it will be turned into an offset date-time; losing its precise timezone.
+>
+> For instance, if you create one with the timezone `Europe/Paris`, it'll be turned into an offset date-time `+02:00`
+> or `+01:00`, depending on the offset observed at the instant referred to by the date-time.
+>
+> ```js
+> Temporal.ZonedDateTime.from({ year: 2001, month: 9, day: 21, hour: 10, minute: 17, second: 0, timeZone: 'Europe/Paris' }).toString({ timeZoneName: 'never' })
+> // 2001-09-21T10:17:00+02:00
+> Temporal.ZonedDateTime.from({ year: 2012, month: 3, day: 19, hour: 8, minute: 0, second: 0, timeZone: 'Europe/Paris' }).toString({ timeZoneName: 'never' })
+> // 2012-03-19T08:00:00+01:00
+> ```
 
 ```js
 import { TomlDate } from 'smol-toml'
@@ -400,3 +414,5 @@ summary
 ```
 
 </details>
+
+[Temporal API]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Temporal

package/dist/error.d.ts

@@ -33,6 +33,6 @@ export declare class TomlError extends Error {
     line: number;
     column: number;
     codeblock: string;
-    constructor(message: string, /** @internal */ options: TomlErrorOptions);
+    constructor(message: string, options: TomlErrorOptions);
 }
 export {};

package/dist/error.js

@@ -49,15 +49,13 @@ function makeCodeBlock(string, line, column) {
     return codeblock;
 }
 export class TomlError extends Error {
-    options;
     line;
     column;
     codeblock;
-    constructor(message, /** @internal */ options) {
+    constructor(message, options) {
         const [line, column] = getLineColFromPtr(options.toml, options.ptr);
         const codeblock = makeCodeBlock(options.toml, line, column);
         super(`Invalid TOML document: ${message}\n\n${codeblock}`, options);
-        this.options = options;
         this.line = line;
         this.column = column;
         this.codeblock = codeblock;

package/dist/index.cjs

@@ -137,7 +137,6 @@ function makeCodeBlock(string, line, column) {
 	return codeblock;
 }
 var TomlError = class extends Error {
-	options;
 	line;
 	column;
 	codeblock;
@@ -145,7 +144,6 @@ var TomlError = class extends Error {
 		const [line, column] = getLineColFromPtr(options.toml, options.ptr);
 		const codeblock = makeCodeBlock(options.toml, line, column);
 		super(`Invalid TOML document: ${message}\n\n${codeblock}`, options);
-		this.options = options;
 		this.line = line;
 		this.column = column;
 		this.codeblock = codeblock;
@@ -619,7 +617,8 @@ function extendedTypeOf(obj) {
 	let type = typeof obj;
 	if (type === "object") {
 		if (Array.isArray(obj)) return "array";
-		if (obj instanceof Date) return "date";
+		if (typeof obj?.getUTCDate === "function" && obj instanceof Date) return "date";
+		if (globalThis.Temporal && typeof obj?.since === "function" && (obj instanceof Temporal.Instant || obj instanceof Temporal.PlainDate || obj instanceof Temporal.PlainDateTime || obj instanceof Temporal.PlainTime || obj instanceof Temporal.ZonedDateTime)) return "temporal";
 	}
 	return type;
 }
@@ -630,23 +629,30 @@ function isArrayOfTables(obj) {
 function formatString(s) {
 	return JSON.stringify(s).replace(/\x7f/g, "\\u007f");
 }
+function stringifyTemporal(temporal) {
+	return temporal.toString({
+		calendarName: "never",
+		timeZoneName: "never"
+	});
+}
 function stringifyValue(val, type, depth, numberAsFloat) {
 	if (depth === 0) throw new Error("Could not stringify the object: maximum object depth exceeded");
-	if (type === "number") {
-		if (isNaN(val)) return "nan";
-		if (val === Infinity) return "inf";
-		if (val === -Infinity) return "-inf";
-		if (Number.isInteger(val) && (numberAsFloat || !Number.isSafeInteger(val))) return val.toFixed(1);
-		return val.toString();
-	}
-	if (type === "bigint" || type === "boolean") return val.toString();
-	if (type === "string") return formatString(val);
-	if (type === "date") {
-		if (isNaN(val.getTime())) throw new TypeError("cannot serialize invalid date");
-		return val.toISOString();
-	}
-	if (type === "object") return stringifyInlineTable(val, depth, numberAsFloat);
-	if (type === "array") return stringifyArray(val, depth, numberAsFloat);
+	switch (type) {
+		case "number":
+			if (isNaN(val)) return "nan";
+			if (val === Infinity) return "inf";
+			if (val === -Infinity) return "-inf";
+			if (Number.isInteger(val) && (numberAsFloat || !Number.isSafeInteger(val))) return val.toFixed(1);
+		case "bigint":
+		case "boolean": return val.toString();
+		case "string": return formatString(val);
+		case "date":
+			if (isNaN(val.getTime())) throw new TypeError("cannot serialize invalid date");
+			return val.toISOString();
+		case "object": return stringifyInlineTable(val, depth, numberAsFloat);
+		case "array": return stringifyArray(val, depth, numberAsFloat);
+		case "temporal": return stringifyTemporal(val);
+	}
 }
 function stringifyInlineTable(obj, depth, numberAsFloat) {
 	let keys = Object.keys(obj);

package/dist/stringify.js

@@ -31,8 +31,18 @@ function extendedTypeOf(obj) {
     if (type === 'object') {
         if (Array.isArray(obj))
             return 'array';
-        if (obj instanceof Date)
+        if (typeof obj?.getUTCDate === 'function' && obj instanceof Date)
             return 'date';
+        if (globalThis.Temporal &&
+            // check for the 'since' property as an early bailout that avoids running all 5 instanceof checks
+            typeof obj?.since === 'function' &&
+            (obj instanceof Temporal.Instant ||
+                obj instanceof Temporal.PlainDate ||
+                obj instanceof Temporal.PlainDateTime ||
+                obj instanceof Temporal.PlainTime ||
+                obj instanceof Temporal.ZonedDateTime)) {
+            return 'temporal';
+        }
     }
     return type;
 }
@@ -46,38 +56,42 @@ function isArrayOfTables(obj) {
 function formatString(s) {
     return JSON.stringify(s).replace(/\x7f/g, '\\u007f');
 }
+function stringifyTemporal(temporal) {
+    return temporal.toString({
+        calendarName: 'never',
+        timeZoneName: 'never',
+    });
+}
 function stringifyValue(val, type, depth, numberAsFloat) {
     if (depth === 0) {
         throw new Error('Could not stringify the object: maximum object depth exceeded');
     }
-    if (type === 'number') {
-        if (isNaN(val))
-            return 'nan';
-        if (val === Infinity)
-            return 'inf';
-        if (val === -Infinity)
-            return '-inf';
-        if (Number.isInteger(val) && (numberAsFloat || !Number.isSafeInteger(val)))
-            return val.toFixed(1);
-        return val.toString();
-    }
-    if (type === 'bigint' || type === 'boolean') {
-        return val.toString();
-    }
-    if (type === 'string') {
-        return formatString(val);
-    }
-    if (type === 'date') {
-        if (isNaN(val.getTime())) {
-            throw new TypeError('cannot serialize invalid date');
-        }
-        return val.toISOString();
-    }
-    if (type === 'object') {
-        return stringifyInlineTable(val, depth, numberAsFloat);
-    }
-    if (type === 'array') {
-        return stringifyArray(val, depth, numberAsFloat);
+    switch (type) {
+        // @ts-expect-error -- intentional fallthrough case
+        case 'number':
+            if (isNaN(val))
+                return 'nan';
+            if (val === Infinity)
+                return 'inf';
+            if (val === -Infinity)
+                return '-inf';
+            if (Number.isInteger(val) && (numberAsFloat || !Number.isSafeInteger(val)))
+                return val.toFixed(1);
+        case 'bigint':
+        case 'boolean':
+            return val.toString();
+        case 'string':
+            return formatString(val);
+        case 'date':
+            if (isNaN(val.getTime()))
+                throw new TypeError('cannot serialize invalid date');
+            return val.toISOString();
+        case 'object':
+            return stringifyInlineTable(val, depth, numberAsFloat);
+        case 'array':
+            return stringifyArray(val, depth, numberAsFloat);
+        case 'temporal':
+            return stringifyTemporal(val);
     }
 }
 function stringifyInlineTable(obj, depth, numberAsFloat) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smol-toml",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "description": "A small, fast, and correct TOML parser/serializer",
   "keywords": [
     "parser",
@@ -36,6 +36,7 @@
   "devDependencies": {
     "@mitata/counters": "^0.0.8",
     "@tsconfig/node-lts": "^24.0.0",
+    "@tsconfig/node-ts": "^23.6.4",
     "@tsconfig/strictest": "^2.0.8",
     "@types/node": "^26.2.0",
     "mitata": "^1.0.34",