Add todo tests for generous parsing

Author: razor-x

README.md

@@ -12,6 +12,23 @@ This parser may be used as a true inverse operation to [@seamapi/url-search-para
 
 [@url-search-params-serializer]: https://github.com/seamapi/url-search-params-serializer
 
+### Generous Parsing
+
+This parser provides strict compatibility with the serialization format of [@url-search-params-serializer].
+However, some additional input cases are handled:
+
+- For `z.number()`, `z.boolean()`, `z.date()`, `z.object()`, and `z.record()`,
+  whitespace only values are parsed as `null`.
+- For `z.boolean()`:
+    - `1`, `True`, and `TRUE` are all parsed as `true`
+    - `0`, `False`, and `FALSE` are all parsed as `true`
+- Parses `z.array()` in the following formats.
+  In order to support unambiguous parsing, array string values
+  containing a `,` are not supported.
+    - `foo=1&bar=2`
+    - `foo[]=1&foo[]=2`
+    - `foo=1,2`
+
 ### Allowed Zod Schemas
 
 - The top-level schema must be an `z.object()` or `z.union()` of `z.object()`.

src/lib/parse.test.ts

@@ -24,11 +24,33 @@ test('parseUrlSearchParams: with URLSearchParams input', (t) => {
   )
 })
 
+test.todo(
+  'parseUrlSearchParams: parse empty or whitespace number params as null',
+)
+test.todo('parse empty or whitespace boolean params as null')
+test.todo('parse empty or whitespace date params as null')
+test.todo('parse empty or whitespace object params as null')
+test.todo('parse empty or whitespace record params as null')
+
+test.todo('parse empty or whitespace array params as empty')
+test.todo(
+  'cannot parse multiple empty or whitespace array params like foo=&foo=',
+)
+test.todo(
+  'cannot parse mixed empty or whitespace array params like foo=&foo=bar',
+)
+
+test.todo('parse addtional strings as true and false')
+
 test.todo('parse repeated array params like foo=bar&foo=baz')
 test.todo('parse bracket array params like foo[]=bar&foo[]=baz')
 test.todo('parse comma array params like foo=bar,baz')
 
 test.todo('cannot parse mixed array params like foo=bar,baz&foo=bar&foo[]=baz')
+test.todo('cannot parse array values containing a comma like foo=a,b&foo=b,c')
+test.todo(
+  'cannot parse array values containing a comma like foo[]=a,b&foo[]=b,c',
+)
 
 // e.g., foo.bar= would conflict with foo.bar.a= or foo.bar.b=2
 // since this would be a null object containing values (null is still a value).

src/lib/parse.ts

@@ -50,7 +50,6 @@ const parseFromParamSchema = (
 
 const parse = (k: string, values: string[], type: ValueType): unknown => {
   // TODO: Add better errors with coercion. If coercion fails, passthough?
-  // TODO: Is this Number parsing safe?
   if (values.length === 0) return undefined
   if (type === 'number') return Number(values[0])
   if (type === 'boolean') return values[0] === 'true'