@toon-format/spec 1.3.2 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +3 -2
  3. package/SPEC.md +252 -100
  4. package/VERSIONING.md +0 -13
  5. package/package.json +1 -1
  6. package/tests/README.md +27 -23
  7. package/tests/fixtures/decode/arrays-nested.json +40 -21
  8. package/tests/fixtures/decode/arrays-primitive.json +14 -14
  9. package/tests/fixtures/decode/arrays-tabular.json +28 -5
  10. package/tests/fixtures/decode/blank-lines.json +14 -14
  11. package/tests/fixtures/decode/delimiters.json +46 -29
  12. package/tests/fixtures/decode/indentation-errors.json +16 -50
  13. package/tests/fixtures/decode/numbers.json +142 -0
  14. package/tests/fixtures/decode/objects.json +29 -29
  15. package/tests/fixtures/decode/primitives.json +44 -75
  16. package/tests/fixtures/decode/root-form.json +17 -0
  17. package/tests/fixtures/decode/validation-errors.json +29 -9
  18. package/tests/fixtures/decode/whitespace.json +61 -0
  19. package/tests/fixtures/encode/arrays-nested.json +15 -15
  20. package/tests/fixtures/encode/arrays-objects.json +16 -16
  21. package/tests/fixtures/encode/arrays-primitive.json +14 -14
  22. package/tests/fixtures/encode/arrays-tabular.json +8 -8
  23. package/tests/fixtures/encode/delimiters.json +23 -23
  24. package/tests/fixtures/encode/objects.json +27 -27
  25. package/tests/fixtures/encode/options.json +1 -1
  26. package/tests/fixtures/encode/primitives.json +61 -36
  27. package/tests/fixtures/encode/whitespace.json +18 -3
  28. package/tests/fixtures.schema.json +3 -4
  29. package/tests/fixtures/encode/normalization.json +0 -107
package/tests/fixtures/encode/arrays-nested.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.3",
2
+ "version": "1.4",
3
3
  "category": "encode",
4
4
  "description": "Nested and mixed array encoding - arrays of arrays, mixed type arrays, root arrays",
5
5
  "tests": [
@@ -9,7 +9,7 @@
9
9
  "pairs": [["a", "b"], ["c", "d"]]
10
10
  },
11
11
  "expected": "pairs[2]:\n - [2]: a,b\n - [2]: c,d",
12
- "specSection": "7.3"
12
+ "specSection": "9.2"
13
13
  },
14
14
  {
15
15
  "name": "quotes strings containing delimiters in nested arrays",
@@ -17,53 +17,53 @@
17
17
  "pairs": [["a", "b"], ["c,d", "e:f", "true"]]
18
18
  },
19
19
  "expected": "pairs[2]:\n - [2]: a,b\n - [3]: \"c,d\",\"e:f\",\"true\"",
20
- "specSection": "7.3"
20
+ "specSection": "9.2"
21
21
  },
22
22
  {
23
- "name": "handles empty inner arrays",
23
+ "name": "encodes empty inner arrays",
24
24
  "input": {
25
25
  "pairs": [[], []]
26
26
  },
27
27
  "expected": "pairs[2]:\n - [0]:\n - [0]:",
28
- "specSection": "7.3"
28
+ "specSection": "9.2"
29
29
  },
30
30
  {
31
- "name": "handles mixed-length inner arrays",
31
+ "name": "encodes mixed-length inner arrays",
32
32
  "input": {
33
33
  "pairs": [[1], [2, 3]]
34
34
  },
35
35
  "expected": "pairs[2]:\n - [1]: 1\n - [2]: 2,3",
36
- "specSection": "7.3"
36
+ "specSection": "9.2"
37
37
  },
38
38
  {
39
39
  "name": "encodes root-level primitive array",
40
40
  "input": ["x", "y", "true", true, 10],
41
41
  "expected": "[5]: x,y,\"true\",true,10",
42
- "specSection": "7"
42
+ "specSection": "9.1"
43
43
  },
44
44
  {
45
45
  "name": "encodes root-level array of uniform objects in tabular format",
46
46
  "input": [{ "id": 1 }, { "id": 2 }],
47
47
  "expected": "[2]{id}:\n 1\n 2",
48
- "specSection": "7.2"
48
+ "specSection": "9.3"
49
49
  },
50
50
  {
51
51
  "name": "encodes root-level array of non-uniform objects in list format",
52
52
  "input": [{ "id": 1 }, { "id": 2, "name": "Ada" }],
53
53
  "expected": "[2]:\n - id: 1\n - id: 2\n name: Ada",
54
- "specSection": "7"
54
+ "specSection": "9.4"
55
55
  },
56
56
  {
57
57
  "name": "encodes empty root-level array",
58
58
  "input": [],
59
59
  "expected": "[0]:",
60
- "specSection": "7"
60
+ "specSection": "9.1"
61
61
  },
62
62
  {
63
63
  "name": "encodes root-level arrays of arrays",
64
64
  "input": [[1, 2], []],
65
65
  "expected": "[2]:\n - [2]: 1,2\n - [0]:",
66
- "specSection": "7.3"
66
+ "specSection": "9.2"
67
67
  },
68
68
  {
69
69
  "name": "encodes complex nested structure",
@@ -77,7 +77,7 @@
77
77
  }
78
78
  },
79
79
  "expected": "user:\n id: 123\n name: Ada\n tags[2]: reading,gaming\n active: true\n prefs[0]:",
80
- "specSection": "6"
80
+ "specSection": "8"
81
81
  },
82
82
  {
83
83
  "name": "uses list format for arrays mixing primitives and objects",
@@ -85,7 +85,7 @@
85
85
  "items": [1, { "a": 1 }, "text"]
86
86
  },
87
87
  "expected": "items[3]:\n - 1\n - a: 1\n - text",
88
- "specSection": "7.3"
88
+ "specSection": "9.4"
89
89
  },
90
90
  {
91
91
  "name": "uses list format for arrays mixing objects and arrays",
@@ -93,7 +93,7 @@
93
93
  "items": [{ "a": 1 }, [1, 2]]
94
94
  },
95
95
  "expected": "items[2]:\n - a: 1\n - [2]: 1,2",
96
- "specSection": "7.3"
96
+ "specSection": "9.4"
97
97
  }
98
98
  ]
99
99
  }
package/tests/fixtures/encode/arrays-objects.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.3",
2
+ "version": "1.4",
3
3
  "category": "encode",
4
4
  "description": "Arrays of objects encoding - list format for non-uniform objects and complex structures",
5
5
  "tests": [
@@ -12,7 +12,7 @@
12
12
  ]
13
13
  },
14
14
  "expected": "items[2]:\n - id: 1\n name: First\n - id: 2\n name: Second\n extra: true",
15
- "specSection": "7"
15
+ "specSection": "9.4"
16
16
  },
17
17
  {
18
18
  "name": "uses list format for objects with nested values",
@@ -22,7 +22,7 @@
22
22
  ]
23
23
  },
24
24
  "expected": "items[1]:\n - id: 1\n nested:\n x: 1",
25
- "specSection": "7"
25
+ "specSection": "9.4"
26
26
  },
27
27
  {
28
28
  "name": "preserves field order in list items - array first",
@@ -30,7 +30,7 @@
30
30
  "items": [{ "nums": [1, 2, 3], "name": "test" }]
31
31
  },
32
32
  "expected": "items[1]:\n - nums[3]: 1,2,3\n name: test",
33
- "specSection": "7"
33
+ "specSection": "10"
34
34
  },
35
35
  {
36
36
  "name": "preserves field order in list items - primitive first",
@@ -38,7 +38,7 @@
38
38
  "items": [{ "name": "test", "nums": [1, 2, 3] }]
39
39
  },
40
40
  "expected": "items[1]:\n - name: test\n nums[3]: 1,2,3",
41
- "specSection": "7"
41
+ "specSection": "10"
42
42
  },
43
43
  {
44
44
  "name": "uses list format for objects containing arrays of arrays",
@@ -48,7 +48,7 @@
48
48
  ]
49
49
  },
50
50
  "expected": "items[1]:\n - matrix[2]:\n - [2]: 1,2\n - [2]: 3,4\n name: grid",
51
- "specSection": "7"
51
+ "specSection": "10"
52
52
  },
53
53
  {
54
54
  "name": "uses tabular format for nested uniform object arrays",
@@ -58,7 +58,7 @@
58
58
  ]
59
59
  },
60
60
  "expected": "items[1]:\n - users[2]{id,name}:\n 1,Ada\n 2,Bob\n status: active",
61
- "specSection": "7"
61
+ "specSection": "10"
62
62
  },
63
63
  {
64
64
  "name": "uses list format for nested object arrays with mismatched keys",
@@ -68,7 +68,7 @@
68
68
  ]
69
69
  },
70
70
  "expected": "items[1]:\n - users[2]:\n - id: 1\n name: Ada\n - id: 2\n status: active",
71
- "specSection": "7"
71
+ "specSection": "10"
72
72
  },
73
73
  {
74
74
  "name": "uses list format for objects with multiple array fields",
@@ -76,7 +76,7 @@
76
76
  "items": [{ "nums": [1, 2], "tags": ["a", "b"], "name": "test" }]
77
77
  },
78
78
  "expected": "items[1]:\n - nums[2]: 1,2\n tags[2]: a,b\n name: test",
79
- "specSection": "7"
79
+ "specSection": "10"
80
80
  },
81
81
  {
82
82
  "name": "uses list format for objects with only array fields",
@@ -84,17 +84,17 @@
84
84
  "items": [{ "nums": [1, 2, 3], "tags": ["a", "b"] }]
85
85
  },
86
86
  "expected": "items[1]:\n - nums[3]: 1,2,3\n tags[2]: a,b",
87
- "specSection": "7"
87
+ "specSection": "10"
88
88
  },
89
89
  {
90
- "name": "handles objects with empty arrays in list format",
90
+ "name": "encodes objects with empty arrays in list format",
91
91
  "input": {
92
92
  "items": [
93
93
  { "name": "test", "data": [] }
94
94
  ]
95
95
  },
96
96
  "expected": "items[1]:\n - name: test\n data[0]:",
97
- "specSection": "7"
97
+ "specSection": "10"
98
98
  },
99
99
  {
100
100
  "name": "places first field of nested tabular arrays on hyphen line",
@@ -102,7 +102,7 @@
102
102
  "items": [{ "users": [{ "id": 1 }, { "id": 2 }], "note": "x" }]
103
103
  },
104
104
  "expected": "items[1]:\n - users[2]{id}:\n 1\n 2\n note: x",
105
- "specSection": "7"
105
+ "specSection": "10"
106
106
  },
107
107
  {
108
108
  "name": "places empty arrays on hyphen line when first",
@@ -110,7 +110,7 @@
110
110
  "items": [{ "data": [], "name": "x" }]
111
111
  },
112
112
  "expected": "items[1]:\n - data[0]:\n name: x",
113
- "specSection": "7"
113
+ "specSection": "10"
114
114
  },
115
115
  {
116
116
  "name": "uses field order from first object for tabular headers",
@@ -121,7 +121,7 @@
121
121
  ]
122
122
  },
123
123
  "expected": "items[2]{a,b,c}:\n 1,2,3\n 10,20,30",
124
- "specSection": "7.2"
124
+ "specSection": "9.3"
125
125
  },
126
126
  {
127
127
  "name": "uses list format when one object has nested column",
@@ -132,7 +132,7 @@
132
132
  ]
133
133
  },
134
134
  "expected": "items[2]:\n - id: 1\n data: string\n - id: 2\n data:\n nested: true",
135
- "specSection": "7"
135
+ "specSection": "9.4"
136
136
  }
137
137
  ]
138
138
  }
package/tests/fixtures/encode/arrays-primitive.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.3",
2
+ "version": "1.4",
3
3
  "category": "encode",
4
4
  "description": "Primitive array encoding - inline arrays of strings, numbers, booleans",
5
5
  "tests": [
@@ -9,7 +9,7 @@
9
9
  "tags": ["reading", "gaming"]
10
10
  },
11
11
  "expected": "tags[2]: reading,gaming",
12
- "specSection": "7.1"
12
+ "specSection": "9.1"
13
13
  },
14
14
  {
15
15
  "name": "encodes number arrays inline",
@@ -17,7 +17,7 @@
17
17
  "nums": [1, 2, 3]
18
18
  },
19
19
  "expected": "nums[3]: 1,2,3",
20
- "specSection": "7.1"
20
+ "specSection": "9.1"
21
21
  },
22
22
  {
23
23
  "name": "encodes mixed primitive arrays inline",
@@ -25,7 +25,7 @@
25
25
  "data": ["x", "y", true, 10]
26
26
  },
27
27
  "expected": "data[4]: x,y,true,10",
28
- "specSection": "7.1"
28
+ "specSection": "9.1"
29
29
  },
30
30
  {
31
31
  "name": "encodes empty arrays",
@@ -33,31 +33,31 @@
33
33
  "items": []
34
34
  },
35
35
  "expected": "items[0]:",
36
- "specSection": "7.1"
36
+ "specSection": "9.1"
37
37
  },
38
38
  {
39
- "name": "handles empty string in single-item array",
39
+ "name": "encodes empty string in single-item array",
40
40
  "input": {
41
41
  "items": [""]
42
42
  },
43
43
  "expected": "items[1]: \"\"",
44
- "specSection": "7.1"
44
+ "specSection": "9.1"
45
45
  },
46
46
  {
47
- "name": "handles empty string in multi-item array",
47
+ "name": "encodes empty string in multi-item array",
48
48
  "input": {
49
49
  "items": ["a", "", "b"]
50
50
  },
51
51
  "expected": "items[3]: a,\"\",b",
52
- "specSection": "7.1"
52
+ "specSection": "9.1"
53
53
  },
54
54
  {
55
- "name": "handles whitespace-only strings in arrays",
55
+ "name": "encodes whitespace-only strings in arrays",
56
56
  "input": {
57
57
  "items": [" ", " "]
58
58
  },
59
59
  "expected": "items[2]: \" \",\" \"",
60
- "specSection": "7.1"
60
+ "specSection": "9.1"
61
61
  },
62
62
  {
63
63
  "name": "quotes array strings with comma",
@@ -65,7 +65,7 @@
65
65
  "items": ["a", "b,c", "d:e"]
66
66
  },
67
67
  "expected": "items[3]: a,\"b,c\",\"d:e\"",
68
- "specSection": "7.1"
68
+ "specSection": "9.1"
69
69
  },
70
70
  {
71
71
  "name": "quotes strings that look like booleans in arrays",
@@ -73,7 +73,7 @@
73
73
  "items": ["x", "true", "42", "-3.14"]
74
74
  },
75
75
  "expected": "items[4]: x,\"true\",\"42\",\"-3.14\"",
76
- "specSection": "7.1"
76
+ "specSection": "9.1"
77
77
  },
78
78
  {
79
79
  "name": "quotes strings with structural meanings in arrays",
@@ -81,7 +81,7 @@
81
81
  "items": ["[5]", "- item", "{key}"]
82
82
  },
83
83
  "expected": "items[3]: \"[5]\",\"- item\",\"{key}\"",
84
- "specSection": "7.1"
84
+ "specSection": "9.1"
85
85
  }
86
86
  ]
87
87
  }
package/tests/fixtures/encode/arrays-tabular.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.3",
2
+ "version": "1.4",
3
3
  "category": "encode",
4
4
  "description": "Tabular array encoding - arrays of uniform objects with primitive values",
5
5
  "tests": [
@@ -12,10 +12,10 @@
12
12
  ]
13
13
  },
14
14
  "expected": "items[2]{sku,qty,price}:\n A1,2,9.99\n B2,1,14.5",
15
- "specSection": "7.2"
15
+ "specSection": "9.3"
16
16
  },
17
17
  {
18
- "name": "handles null values in tabular format",
18
+ "name": "encodes null values in tabular format",
19
19
  "input": {
20
20
  "items": [
21
21
  { "id": 1, "value": null },
@@ -23,7 +23,7 @@
23
23
  ]
24
24
  },
25
25
  "expected": "items[2]{id,value}:\n 1,null\n 2,test",
26
- "specSection": "7.2"
26
+ "specSection": "9.3"
27
27
  },
28
28
  {
29
29
  "name": "quotes strings containing delimiters in tabular rows",
@@ -34,7 +34,7 @@
34
34
  ]
35
35
  },
36
36
  "expected": "items[2]{sku,desc,qty}:\n \"A,1\",cool,2\n B2,\"wip: test\",1",
37
- "specSection": "7.2"
37
+ "specSection": "9.3"
38
38
  },
39
39
  {
40
40
  "name": "quotes ambiguous strings in tabular rows",
@@ -45,10 +45,10 @@
45
45
  ]
46
46
  },
47
47
  "expected": "items[2]{id,status}:\n 1,\"true\"\n 2,\"false\"",
48
- "specSection": "7.2"
48
+ "specSection": "9.3"
49
49
  },
50
50
  {
51
- "name": "handles tabular arrays with keys needing quotes",
51
+ "name": "encodes tabular arrays with keys needing quotes",
52
52
  "input": {
53
53
  "items": [
54
54
  { "order:id": 1, "full name": "Ada" },
@@ -56,7 +56,7 @@
56
56
  ]
57
57
  },
58
58
  "expected": "items[2]{\"order:id\",\"full name\"}:\n 1,Ada\n 2,Bob",
59
- "specSection": "7.2"
59
+ "specSection": "9.3"
60
60
  }
61
61
  ]
62
62
  }
package/tests/fixtures/encode/delimiters.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.3",
2
+ "version": "1.4",
3
3
  "category": "encode",
4
4
  "description": "Delimiter options - tab and pipe delimiters, delimiter-aware quoting",
5
5
  "tests": [
@@ -12,7 +12,7 @@
12
12
  "options": {
13
13
  "delimiter": "\t"
14
14
  },
15
- "specSection": "8"
15
+ "specSection": "11"
16
16
  },
17
17
  {
18
18
  "name": "encodes primitive arrays with pipe delimiter",
@@ -23,7 +23,7 @@
23
23
  "options": {
24
24
  "delimiter": "|"
25
25
  },
26
- "specSection": "8"
26
+ "specSection": "11"
27
27
  },
28
28
  {
29
29
  "name": "encodes primitive arrays with comma delimiter",
@@ -34,7 +34,7 @@
34
34
  "options": {
35
35
  "delimiter": ","
36
36
  },
37
- "specSection": "8"
37
+ "specSection": "11"
38
38
  },
39
39
  {
40
40
  "name": "encodes tabular arrays with tab delimiter",
@@ -48,7 +48,7 @@
48
48
  "options": {
49
49
  "delimiter": "\t"
50
50
  },
51
- "specSection": "8"
51
+ "specSection": "11"
52
52
  },
53
53
  {
54
54
  "name": "encodes tabular arrays with pipe delimiter",
@@ -62,7 +62,7 @@
62
62
  "options": {
63
63
  "delimiter": "|"
64
64
  },
65
- "specSection": "8"
65
+ "specSection": "11"
66
66
  },
67
67
  {
68
68
  "name": "encodes nested arrays with tab delimiter",
@@ -73,7 +73,7 @@
73
73
  "options": {
74
74
  "delimiter": "\t"
75
75
  },
76
- "specSection": "8"
76
+ "specSection": "11"
77
77
  },
78
78
  {
79
79
  "name": "encodes nested arrays with pipe delimiter",
@@ -84,7 +84,7 @@
84
84
  "options": {
85
85
  "delimiter": "|"
86
86
  },
87
- "specSection": "8"
87
+ "specSection": "11"
88
88
  },
89
89
  {
90
90
  "name": "encodes root arrays with tab delimiter",
@@ -93,7 +93,7 @@
93
93
  "options": {
94
94
  "delimiter": "\t"
95
95
  },
96
- "specSection": "8"
96
+ "specSection": "11"
97
97
  },
98
98
  {
99
99
  "name": "encodes root arrays with pipe delimiter",
@@ -102,7 +102,7 @@
102
102
  "options": {
103
103
  "delimiter": "|"
104
104
  },
105
- "specSection": "8"
105
+ "specSection": "11"
106
106
  },
107
107
  {
108
108
  "name": "encodes root arrays of objects with tab delimiter",
@@ -111,7 +111,7 @@
111
111
  "options": {
112
112
  "delimiter": "\t"
113
113
  },
114
- "specSection": "8"
114
+ "specSection": "11"
115
115
  },
116
116
  {
117
117
  "name": "encodes root arrays of objects with pipe delimiter",
@@ -120,7 +120,7 @@
120
120
  "options": {
121
121
  "delimiter": "|"
122
122
  },
123
- "specSection": "8"
123
+ "specSection": "11"
124
124
  },
125
125
  {
126
126
  "name": "quotes strings containing tab delimiter",
@@ -131,7 +131,7 @@
131
131
  "options": {
132
132
  "delimiter": "\t"
133
133
  },
134
- "specSection": "8"
134
+ "specSection": "11"
135
135
  },
136
136
  {
137
137
  "name": "quotes strings containing pipe delimiter",
@@ -142,7 +142,7 @@
142
142
  "options": {
143
143
  "delimiter": "|"
144
144
  },
145
- "specSection": "8"
145
+ "specSection": "11"
146
146
  },
147
147
  {
148
148
  "name": "does not quote commas with tab delimiter",
@@ -153,7 +153,7 @@
153
153
  "options": {
154
154
  "delimiter": "\t"
155
155
  },
156
- "specSection": "8"
156
+ "specSection": "11"
157
157
  },
158
158
  {
159
159
  "name": "does not quote commas with pipe delimiter",
@@ -164,7 +164,7 @@
164
164
  "options": {
165
165
  "delimiter": "|"
166
166
  },
167
- "specSection": "8"
167
+ "specSection": "11"
168
168
  },
169
169
  {
170
170
  "name": "quotes tabular values containing comma delimiter",
@@ -178,7 +178,7 @@
178
178
  "options": {
179
179
  "delimiter": ","
180
180
  },
181
- "specSection": "8"
181
+ "specSection": "11"
182
182
  },
183
183
  {
184
184
  "name": "does not quote commas in tabular values with tab delimiter",
@@ -192,7 +192,7 @@
192
192
  "options": {
193
193
  "delimiter": "\t"
194
194
  },
195
- "specSection": "8"
195
+ "specSection": "11"
196
196
  },
197
197
  {
198
198
  "name": "does not quote commas in object values with pipe delimiter",
@@ -203,7 +203,7 @@
203
203
  "options": {
204
204
  "delimiter": "|"
205
205
  },
206
- "specSection": "8"
206
+ "specSection": "11"
207
207
  },
208
208
  {
209
209
  "name": "does not quote commas in object values with tab delimiter",
@@ -214,7 +214,7 @@
214
214
  "options": {
215
215
  "delimiter": "\t"
216
216
  },
217
- "specSection": "8"
217
+ "specSection": "11"
218
218
  },
219
219
  {
220
220
  "name": "quotes nested array values containing pipe delimiter",
@@ -225,7 +225,7 @@
225
225
  "options": {
226
226
  "delimiter": "|"
227
227
  },
228
- "specSection": "8"
228
+ "specSection": "11"
229
229
  },
230
230
  {
231
231
  "name": "quotes nested array values containing tab delimiter",
@@ -236,7 +236,7 @@
236
236
  "options": {
237
237
  "delimiter": "\t"
238
238
  },
239
- "specSection": "8"
239
+ "specSection": "11"
240
240
  },
241
241
  {
242
242
  "name": "preserves ambiguity quoting regardless of delimiter",
@@ -247,7 +247,7 @@
247
247
  "options": {
248
248
  "delimiter": "|"
249
249
  },
250
- "specSection": "8"
250
+ "specSection": "11"
251
251
  }
252
252
  ]
253
253
  }