Add parseUrlSearchParams with failing tests

Author: razor-x

examples/index.ts

@@ -2,8 +2,8 @@
 
 import landlubber from 'landlubber'
 
-import * as todo from './todo.js'
+import * as parse from './parse.js'
 
-const commands = [todo]
+const commands = [parse]
 
 await landlubber(commands).parse()

examples/parse.ts

@@ -0,0 +1,47 @@
+import type { Builder, Command, Describe, Handler } from 'landlubber'
+import { z } from 'zod'
+
+import { parseUrlSearchParams } from '@seamapi/url-search-params-parser'
+
+interface Options {
+  query: string
+}
+
+export const command: Command = 'parse query'
+
+export const describe: Describe = 'Parse query'
+
+export const builder: Builder = {
+  query: {
+    type: 'string',
+    describe: 'Query string',
+  },
+}
+
+export const handler: Handler<Options> = async ({ query, logger }) => {
+  logger.info({ data: parseUrlSearchParams(query, schema) }, 'params')
+}
+
+const schema = z
+  .object({
+    a: z.string(),
+    b: z.number(),
+    c: z.boolean(),
+    d: z.null(),
+    e: z.array(z.union([z.string(), z.number()])),
+    f: z.array(z.string()),
+    g: z.date(),
+    h: z.date(),
+    i: z
+      .object({
+        foo: z.number(),
+        bar: z
+          .object({
+            baz: z.number(),
+            fizz: z.array(z.union([z.string(), z.number()])),
+          })
+          .optional(),
+      })
+      .optional(),
+  })
+  .optional()

examples/todo.ts

@@ -67,6 +67,9 @@
     "node": ">=18.12.0",
     "npm": ">= 9.0.0"
   },
+  "peerDependencies": {
+    "zod": "^3.0.0"
+  },
   "devDependencies": {
     "@seamapi/url-search-params-serializer": "^1.2.0",
     "@types/node": "^20.8.10",

package.json

@@ -1 +1 @@
-export { todo } from './todo.js'
+export * from './parse.js'

src/lib/index.ts

@@ -0,0 +1,25 @@
+import test from 'ava'
+import { z } from 'zod'
+
+import { parseUrlSearchParams } from './parse.js'
+
+test.failing('parseUrlSearchParams: with string input', (t) => {
+  t.deepEqual(
+    parseUrlSearchParams(
+      'foo=d&bar=2',
+      z.object({ foo: z.string().optional(), bar: z.number().optional() }),
+    ),
+    { foo: 'd', bar: 2 },
+  )
+})
+
+test.failing('parseUrlSearchParams: with URLSearchParams input', (t) => {
+  t.deepEqual(
+    parseUrlSearchParams(
+      new URLSearchParams('foo=d&bar=2'),
+      z.object({ foo: z.string().optional(), bar: z.number().optional() }),
+    ),
+    { foo: 'd', bar: 2 },
+    'with URLSearchParams input',
+  )
+})

src/lib/parse.test.ts

@@ -0,0 +1,10 @@
+import type { ZodSchema } from 'zod'
+
+export const parseUrlSearchParams = (
+  _query: URLSearchParams | string,
+  _schema: ZodSchema,
+): Record<string, unknown> => {
+  // const _searchParams =
+  //   typeof query === 'string' ? new URLSearchParams(query) : query
+  return {}
+}

src/lib/parse.ts

@@ -0,0 +1,14 @@
+import { serializeUrlSearchParams } from '@seamapi/url-search-params-serializer'
+import test from 'ava'
+import { z } from 'zod'
+
+import { parseUrlSearchParams } from '@seamapi/url-search-params-parser'
+
+test('parses empty string', (t) => {
+  const schema = z.object({ foo: z.string() })
+  const input = {}
+  t.deepEqual(
+    parseUrlSearchParams(serializeUrlSearchParams(input), schema),
+    input,
+  )
+})