smol-toml 0.1.0 → 1.0.0

package/README.md

@@ -2,7 +2,7 @@
 [![License](https://img.shields.io/github/license/squirrelchat/smol-toml.svg?style=flat-square)](https://github.com/squirrelchat/smol-toml/blob/mistress/LICENSE)
 [![npm](https://img.shields.io/npm/v/smol-toml?style=flat-square)](https://npm.im/smol-toml)
 
-A small, fast, and correct TOML parser. smol-toml is (almost) fully spec-compliant with TOML v1.0.0.
+A small, fast, and correct TOML parser. smol-toml is fully spec-compliant with TOML v1.0.0.
 
 Why yet another TOML parser? Well, the ecosystem of TOML parsers in JavaScript is quite underwhelming, most likely due
 to a lack of interest. With most parsers being outdated, unmaintained, non-compliant, or a combination of these, a new
@@ -10,12 +10,7 @@ parser didn't feel too out of place.
 
 *[insert xkcd 927]*
 
-smol-toml only fails to comply with the spec in 2 (minor) ways:
-- comments are not validated (absence of control characters)
-- integers can only be between -9_007_199_254_740_991 and 9_007_199_254_740_991 instead of the recommended full 64-bit range
-	- integers outside of this range do raise an error, complying with the specification on this regard
-
-Otherwise, smol-toml produces valid results (or errors) for all the test TOML files in https://github.com/iarna/toml-spec-tests
+smol-toml produces valid results (or errors) for all the test TOML files in https://github.com/iarna/toml-spec-tests.
 
 ## Installation
 ```
@@ -43,28 +38,41 @@ The large TOML generator can be found [here](https://gist.github.com/cyyynthia/e
 
 |                | smol-toml           | @iarna/toml@3.0.0 | @ltd/j-toml    | fast-toml      |
 |----------------|---------------------|-------------------|----------------|----------------|
-| Spec example   | **37,009.05 op/s**  | 29,203.53 op/s    | 16,225.50 op/s | 23,886.25 op/s |
-| ~5MB test file | **4.6007 op/s**     | *DNF*             | 2.4919 op/s    | 2.5952 op/s    |
+| Spec example   | **60,733.91 op/s**  | 32,565.20 op/s    | 16,781.03 op/s | 31,336.67 op/s |
+| ~5MB test file | **4.2567 op/s**     | *DNF*             | 2.4873 op/s    | 2.5790 op/s    |
 
 <details>
 <summary>Detailed benchmark data</summary>
 
-Tests ran using Vitest v0.31.0 on commit bd69ffb52920ee6f2843356dff3325fc2e868821
+Tests ran using Vitest v0.31.0 on commit 361089f3dbc30d994494bf6ec1e8e2f135531247
 
 CPU: Intel Core i7 7700K (4.2GHz)
 
 ```
-✓ bench/parse.bench.ts (7) 17780ms
-   ✓ TOML spec example (4) 17778ms
+ RUN  v0.31.0
+
+ ✓ bench/parseSpecExample.bench.ts (4) 2466ms
      name                hz     min     max    mean     p75     p99    p995    p999     rme  samples
-   · smol-toml    37,009.05  0.0231  4.1194  0.0270  0.0260  0.0445  0.0500  0.0622  ±2.88%    18505   fastest
-   · @iarna/toml  29,203.53  0.0308  2.1478  0.0342  0.0325  0.0687  0.0714  0.2747  ±1.08%    14602
-   · @ltd/j-toml  16,225.50  0.0519  2.8481  0.0616  0.0545  0.1015  0.1193  1.9987  ±3.20%     8113   slowest
-   · fast-toml    23,886.25  0.0366  1.7331  0.0419  0.0391  0.0758  0.0818  1.1500  ±1.84%    11944
-   ✓ 5MB of TOML (all structures) (3) 17268ms
+   · smol-toml    60,733.91  0.0145  0.2580  0.0165  0.0152  0.0319  0.0345  0.1383  ±0.46%    30367   fastest
+   · @iarna/toml  32,565.20  0.0268  0.3208  0.0307  0.0284  0.0580  0.0619  0.1699  ±0.54%    16283
+   · @ltd/j-toml  16,781.03  0.0505  1.0392  0.0596  0.0540  0.1147  0.1360  0.7657  ±1.52%     8391   slowest
+   · fast-toml    31,336.67  0.0298  0.3357  0.0319  0.0305  0.0578  0.0622  0.1580  ±0.41%    15669
+ ✓ bench/parseLargeMixed.bench.ts (3) 15752ms
      name             hz     min     max    mean     p75     p99    p995    p999     rme  samples
-   · smol-toml    4.6007  208.19  238.94  217.36  229.56  238.94  238.94  238.94  ±4.10%       10   fastest
-   · @ltd/j-toml  2.4919  379.85  428.13  401.31  416.64  428.13  428.13  428.13  ±2.82%       10   slowest
-   · fast-toml    2.5952  375.28  416.15  385.33  393.15  416.15  416.15  416.15  ±2.60%       10
+   · smol-toml    4.2567  225.85  257.42  234.92  242.74  257.42  257.42  257.42  ±3.35%       10   fastest
+   · @ltd/j-toml  2.4873  382.66  441.12  402.05  416.25  441.12  441.12  441.12  ±3.40%       10   slowest
+   · fast-toml    2.5790  377.86  409.32  387.75  392.90  409.32  409.32  409.32  ±2.07%       10
+
+
+ BENCH  Summary
+
+  smol-toml - bench/parseLargeMixed.bench.ts >
+    1.65x faster than fast-toml
+    1.71x faster than @ltd/j-toml
+
+  smol-toml - bench/parseSpecExample.bench.ts >
+    1.86x faster than @iarna/toml
+    1.94x faster than fast-toml
+    3.62x faster than @ltd/j-toml
 ```
 </details>

package/dist/date.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Squirrel Chat et al., All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software without
+ *    specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+export declare let DATE_TIME_RE: RegExp;
+export default class TomlDate extends Date {
+    #private;
+    constructor(date: string | Date);
+    isDateTime(): boolean;
+    isLocal(): boolean;
+    isDate(): boolean;
+    isTime(): boolean;
+    toISOString(): string;
+    static wrapAsOffsetDateTime(jsDate: Date, offset?: string): TomlDate;
+    static wrapAsLocalDateTime(jsDate: Date): TomlDate;
+    static wrapAsLocalDate(jsDate: Date): TomlDate;
+    static wrapAsLocalTime(jsDate: Date): TomlDate;
+}

package/dist/date.js

@@ -0,0 +1,115 @@
+/*!
+ * Copyright (c) Squirrel Chat et al., All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software without
+ *    specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+export let DATE_TIME_RE = /^(\d{4}-\d{2}-\d{2})?[Tt ]?(\d{2}:\d{2}:\d{2}(?:\.\d{3,})?)?(Z|[-+]\d{2}:\d{2})?$/;
+export default class TomlDate extends Date {
+    #hasDate;
+    #hasTime;
+    #offset;
+    constructor(date) {
+        let hasDate = true;
+        let hasTime = true;
+        let offset = 'Z';
+        if (typeof date === 'string') {
+            let match = date.match(DATE_TIME_RE);
+            if (match) {
+                if (!match[1]) {
+                    hasDate = false;
+                    date = `0000-01-01T${date}`;
+                }
+                hasTime = !!match[2];
+                offset = match[3] || null;
+            }
+        }
+        super(date);
+        if (isNaN(this.getTime())) {
+            this.#hasDate = false;
+            this.#hasTime = false;
+            this.#offset = null;
+        }
+        else {
+            this.#hasDate = hasDate;
+            this.#hasTime = hasTime;
+            this.#offset = offset;
+        }
+    }
+    isDateTime() {
+        return this.#hasDate && this.#hasTime;
+    }
+    isLocal() {
+        return !this.#hasTime || !this.#hasTime || !this.#offset;
+    }
+    isDate() {
+        return this.#hasDate && !this.#hasTime;
+    }
+    isTime() {
+        return this.#hasTime && !this.#hasDate;
+    }
+    toISOString() {
+        let iso = super.toISOString();
+        // Local Date
+        if (this.isDate())
+            return iso.slice(0, 10);
+        // Local Time
+        if (this.isTime())
+            return iso.slice(11, 23);
+        // Local DateTime
+        if (this.#offset === null)
+            return iso.slice(0, -1);
+        // Offset DateTime
+        if (this.#offset === 'Z')
+            return iso;
+        // This part is quite annoying: JS strips the original timezone from the ISO string representation
+        // Instead of using a "modified" date and "Z", we restore the representation "as authored"
+        let offset = (+(this.#offset.slice(1, 3)) * 60) + +(this.#offset.slice(4, 6));
+        offset = this.#offset[0] === '-' ? offset : -offset;
+        let offsetDate = new Date(this.getTime() - (offset * 60e3));
+        return offsetDate.toISOString().slice(0, -1) + this.#offset;
+    }
+    static wrapAsOffsetDateTime(jsDate, offset = 'Z') {
+        let date = new TomlDate(jsDate);
+        date.#offset = offset;
+        return date;
+    }
+    static wrapAsLocalDateTime(jsDate) {
+        let date = new TomlDate(jsDate);
+        date.#offset = null;
+        return date;
+    }
+    static wrapAsLocalDate(jsDate) {
+        let date = new TomlDate(jsDate);
+        date.#hasTime = false;
+        date.#offset = null;
+        return date;
+    }
+    static wrapAsLocalTime(jsDate) {
+        let date = new TomlDate(jsDate);
+        date.#hasDate = false;
+        date.#offset = null;
+        return date;
+    }
+}

package/dist/index.d.ts

@@ -25,4 +25,6 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-export declare function parse(toml: string): {};
+import { type TomlPrimitive } from './util.js';
+export { default as TomlDate } from './date.js';
+export declare function parse(toml: string): Record<string, TomlPrimitive>;

package/dist/index.js

@@ -29,12 +29,12 @@ import { parseKey } from './struct.js';
 import { extractKeyValue } from './parse.js';
 import { skipVoid, peekTable } from './util.js';
 import TomlError from './error.js';
+export { default as TomlDate } from './date.js';
 export function parse(toml) {
     let res = {};
     let tbl = res;
     let seenTables = new Set();
     let seenValues = new Set();
-    toml = toml.trim();
     for (let ptr = skipVoid(toml, 0); ptr < toml.length;) {
         if (toml[ptr] === '[') {
             let isTableArray = toml[ptr + 1] === '[';

package/dist/parse.d.ts

@@ -25,5 +25,6 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-export declare function extractValue(str: string, ptr: number, end?: string): [any, number];
-export declare function extractKeyValue(str: string, ptr: number, table: Record<string, any>, seen: Set<any>, isInline?: boolean): number;
+import { type TomlPrimitive } from './util.js';
+export declare function extractValue(str: string, ptr: number, end?: string): [TomlPrimitive, number];
+export declare function extractKeyValue(str: string, ptr: number, table: Record<string, TomlPrimitive>, seen: Set<any>, isInline?: boolean): number;

package/dist/parse.js

@@ -27,7 +27,7 @@
  */
 import { parseString, parseValue } from './primitive.js';
 import { parseKey, parseArray, parseInlineTable } from './struct.js';
-import { peekTable, indexOfNewline, skipUntil, skipVoid } from './util.js';
+import { peekTable, indexOfNewline, skipUntil, skipComment, skipVoid } from './util.js';
 import TomlError from './error.js';
 function getStringEnd(str, seek) {
     let first = str[seek];
@@ -52,6 +52,7 @@ function sliceAndTrimEndOf(str, startPtr, endPtr, allowNewLines) {
     let newlineIdx;
     let commentIdx = value.indexOf('#');
     if (commentIdx > -1) {
+        skipComment(str, commentIdx);
         value = value.slice(0, commentIdx);
     }
     let trimmed = value.trimEnd();
@@ -70,7 +71,7 @@ function sliceAndTrimEndOf(str, startPtr, endPtr, allowNewLines) {
     return trimmed;
 }
 export function extractValue(str, ptr, end) {
-    let c = str[ptr], offset;
+    let c = str[ptr];
     if (c === '[' || c === '{') {
         let [value, endPtr] = c === '['
             ? parseArray(str, ptr)
@@ -90,8 +91,7 @@ export function extractValue(str, ptr, end) {
     let endPtr;
     if (c === '"' || c === "'") {
         endPtr = getStringEnd(str, ptr);
-        offset = !!end && str[endPtr] === ',';
-        return [parseString(str, ptr, endPtr), endPtr + +offset];
+        return [parseString(str, ptr, endPtr), endPtr + +(!!end && str[endPtr] === ',')];
     }
     endPtr = skipUntil(str, ptr, end);
     let valStr = sliceAndTrimEndOf(str, ptr, endPtr - (+(str[endPtr - 1] === ',')), end === ']');

package/dist/primitive.d.ts

@@ -25,5 +25,6 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+import TomlDate from './date.js';
 export declare function parseString(str: string, ptr?: number, endPtr?: number): string;
-export declare function parseValue(value: string, toml: string, ptr: number): boolean | number | Date;
+export declare function parseValue(value: string, toml: string, ptr: number): boolean | number | TomlDate;

package/dist/primitive.js

@@ -26,10 +26,11 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 import { skipVoid } from './util.js';
+import TomlDate, { DATE_TIME_RE } from './date.js';
 import TomlError from './error.js';
 let NUM_REGEX = /^(0x|0b|0o|[+-])?[0-9a-f_]+(\.[0-9a-f_]+)?([e][+-]?[0-9a-f_]+)?$/i;
 let INT_REGEX = /^(0x|0b|0o|[+-])?[0-9a-f]+$/;
-let LEADING_ZERO = /^[+-]?0\d+/;
+let LEADING_ZERO = /^[+-]?0\d/;
 let ESCAPE_REGEX = /^[0-9a-f]{4,8}$/i;
 let ESC_MAP = {
     b: '\b',
@@ -91,7 +92,7 @@ export function parseString(str, ptr = 0, endPtr = str.length) {
                     });
                 }
                 try {
-                    parsed += String.fromCodePoint(+`0x${code}`);
+                    parsed += String.fromCodePoint(parseInt(code, 16));
                 }
                 catch {
                     throw new TomlError('invalid unicode escape', {
@@ -153,12 +154,18 @@ export function parseValue(value, toml, ptr) {
         return numeric;
     }
     // Date
-    let date = new Date(value.includes('-') ? value : `0000-01-01T${value}`);
-    if (isNaN(date.getTime())) {
-        throw new TomlError('invalid value', {
-            toml: toml,
-            ptr: ptr
-        });
+    if (DATE_TIME_RE.test(value)) {
+        let date = new TomlDate(value);
+        if (isNaN(date.getTime())) {
+            throw new TomlError('invalid date', {
+                toml: toml,
+                ptr: ptr
+            });
+        }
+        return date;
     }
-    return date;
+    throw new TomlError('invalid value', {
+        toml: toml,
+        ptr: ptr
+    });
 }

package/dist/struct.d.ts

@@ -25,6 +25,7 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+import { type TomlPrimitive } from './util.js';
 export declare function parseKey(str: string, startPtr?: number, endPtr?: number): string[];
-export declare function parseInlineTable(str: string, ptr: number): [Record<string, any>, number];
-export declare function parseArray(str: string, ptr: number): [any[], number];
+export declare function parseInlineTable(str: string, ptr: number): [Record<string, TomlPrimitive>, number];
+export declare function parseArray(str: string, ptr: number): [TomlPrimitive[], number];

package/dist/struct.js

@@ -27,7 +27,7 @@
  */
 import { parseString } from './primitive.js';
 import { extractValue, extractKeyValue } from './parse.js';
-import { indexOfNewline } from './util.js';
+import { indexOfNewline, skipComment } from './util.js';
 import TomlError from './error.js';
 let KEY_PART_RE = /^[a-zA-Z0-9-_ \t]+$/;
 export function parseKey(str, startPtr = 0, endPtr = str.length) {
@@ -138,7 +138,7 @@ export function parseArray(str, ptr) {
             });
         }
         else if (c === '#')
-            ptr = indexOfNewline(str, ptr);
+            ptr = skipComment(str, ptr);
         else if (c !== ' ' && c !== '\t' && c !== '\n' && c !== '\r') {
             let e = extractValue(str, ptr - 1, ']');
             res.push(e[0]);

package/dist/util.d.ts

@@ -25,7 +25,12 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+import TomlDate from './date.js';
+export type TomlPrimitive = string | number | boolean | TomlDate | {
+    [key: string]: TomlPrimitive;
+} | TomlPrimitive[];
 export declare function indexOfNewline(str: string, start?: number, end?: number): number;
+export declare function skipComment(str: string, ptr: number): number;
 export declare function skipVoid(str: string, ptr: number, banNewLines?: boolean, banComments?: boolean): number;
 export declare function skipUntil(str: string, ptr: number, end?: string): number;
 export declare function peekTable(table: Record<string, any>, key: string[], seen: Set<any>, allowSuper?: boolean): [string, Record<string, any>] | null;

package/dist/util.js

@@ -25,6 +25,7 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+import TomlDate from './date.js';
 import TomlError from './error.js';
 export function indexOfNewline(str, start = 0, end = str.length) {
     for (let i = start; i < end; i++) {
@@ -33,13 +34,27 @@ export function indexOfNewline(str, start = 0, end = str.length) {
     }
     return -1;
 }
+export function skipComment(str, ptr) {
+    for (let i = ptr; i < str.length; i++) {
+        let c = str[i];
+        if (c < '\t' || c === '\x0b' || c === '\x0c' || c === '\x7f' || (c > '\x0d' && c < '\x20')) {
+            throw new TomlError('control characters are not allowed in commebts', {
+                toml: str,
+                ptr: ptr,
+            });
+        }
+        if (c === '\n' || c === '\r')
+            return i;
+    }
+    return -1;
+}
 export function skipVoid(str, ptr, banNewLines, banComments) {
     let c;
     while ((c = str[ptr]) === ' ' || c === '\t' || (!banNewLines && (c === '\n' || c === '\r')))
         ptr++;
     if (banComments || c !== '#')
         return ptr;
-    ptr = indexOfNewline(str, ptr);
+    ptr = skipComment(str, ptr);
     return ptr < 0 ? str.length : skipVoid(str, ptr, banNewLines);
 }
 export function skipUntil(str, ptr, end) {

package/package.json

@@ -1,7 +1,10 @@
 {
 	"name": "smol-toml",
-	"version": "0.1.0",
-	"keywords": [ "toml", "parser" ],
+	"version": "1.0.0",
+	"keywords": [
+		"toml",
+		"parser"
+	],
 	"description": "A small, fast, and correct TOML parser",
 	"repository": "git@github.com:squirrelchat/smol-toml.git",
 	"author": "Cynthia <cyyynthia@borkenware.com>",