Merge pull request #9 from sandros94/fix-build-issues

Fix build issues, better vitests and new UUID util

Author: Intevel

package.json

@@ -11,6 +11,11 @@
     "validation"
   ],
   "sideEffects": false,
+  "build": {
+    "externals": [
+      "valibot"
+    ]
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -34,11 +39,10 @@
   },
   "dependencies": {
     "h3": "^1.13.0",
-    "valibot": "^1.0.0-beta.3"
+    "valibot": "^1.0.0-beta.9"
   },
   "devDependencies": {
     "@antfu/eslint-config": "3.8.0",
-    "@nuxtjs/eslint-config-typescript": "latest",
     "@types/node": "^20",
     "@types/serve-handler": "6.1.4",
     "@typescript-eslint/eslint-plugin": "8.14.0",

pnpm-lock.yaml

@@ -3,13 +3,15 @@ import {
   checkboxAsString,
   intAsString,
   numAsString,
+  uuid,
 } from './schemas'
 
 export const vh = {
   boolAsString,
   checkboxAsString,
   intAsString,
   numAsString,
+  uuid,
 }
 
 export {

src/index.ts

@@ -1,5 +1,5 @@
 // Original code by https://github.com/rileytomasek/zodix/blob/31bd5f2708f2eec4d0522201710dfc5ef887a16e/src/schemas.ts
-import * as v from 'Valibot'
+import * as v from 'valibot'
 
 /**
  * Valibot schema to parse strings that are booleans.
@@ -56,3 +56,14 @@ export const numAsString = v.pipe(
   v.decimal('Must be a number string'),
   v.transform(Number),
 )
+
+/**
+ * Valibot schema to parse strings that are valid UUID.
+ * @example
+ * ```ts
+ * v.parse(vh.uuid, '2') -> throws an error
+ */
+export const uuid = v.pipe(
+  v.string(),
+  v.uuid(),
+)

src/schemas.ts

@@ -24,7 +24,7 @@ describe('useValidatedBody', () => {
     const res = await request.post('/validate').send({ required: true })
 
     expect(res.status).toEqual(200)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toEqual({ required: true })
   })
 
   it('throws 400 Bad Request if body does not match validation schema', async () => {
@@ -33,7 +33,33 @@ describe('useValidatedBody', () => {
     const res = await request.post('/validate').send({})
 
     expect(res.status).toEqual(400)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toMatchInlineSnapshot(`
+      {
+        "data": {
+          "issues": [
+            {
+              "expected": "boolean",
+              "kind": "schema",
+              "message": "Invalid type: Expected boolean but received undefined",
+              "path": [
+                {
+                  "input": {},
+                  "key": "required",
+                  "origin": "value",
+                  "type": "object",
+                },
+              ],
+              "received": "undefined",
+              "type": "boolean",
+            },
+          ],
+          "name": "ValiError",
+        },
+        "stack": [],
+        "statusCode": 400,
+        "statusMessage": "Bad Request",
+      }
+    `)
   })
 
   it('doesn\'t throw 400 Bad Request if body does not match validation schema', async () => {
@@ -42,6 +68,6 @@ describe('useValidatedBody', () => {
     const res = await request.post('/validate').send({})
 
     expect(res.status).toEqual(200)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toEqual(v.safeParse(bodySchema, {}))
   })
 })

test/__snapshots__/body.test.ts.snap

@@ -2,7 +2,7 @@ import type { App, Router } from 'h3'
 import { createApp, createRouter, defineEventHandler, toNodeListener } from 'h3'
 import supertest from 'supertest'
 import { beforeEach, describe, expect, it } from 'vitest'
-import { useSafeValidatedParams, useValidatedParams, v } from '../src'
+import { useSafeValidatedParams, useValidatedParams, v, vh } from '../src'
 
 describe('useValidatedParams', () => {
   let app: App
@@ -26,7 +26,7 @@ describe('useValidatedParams', () => {
     const res = await request.get('/validate/sandros94')
 
     expect(res.status).toEqual(200)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toEqual({ name: 'sandros94' })
   })
 
   it('throws 400 Bad Request if params does not match validation schema', async () => {
@@ -35,15 +35,51 @@ describe('useValidatedParams', () => {
     const res = await request.get('/validate')
 
     expect(res.status).toEqual(404)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toEqual({
+      stack: [],
+      statusCode: 404,
+      statusMessage: 'Cannot find any path matching /validate.',
+    })
   })
 
   it('doesn\'t throw 400 Bad Request if params does not match validation schema', async () => {
-    router.get('/validate/:name', defineEventHandler(event => useSafeValidatedParams(event, paramsSchema)))
+    router.get('/validate/:id', defineEventHandler(event => useSafeValidatedParams(event, v.object({
+      id: vh.uuid,
+    }))))
 
-    const res = await request.get('/validate/2') // TODO: this is not actually correct
+    const res = await request.get('/validate/2')
 
     expect(res.status).toEqual(200)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toMatchInlineSnapshot(`
+      {
+        "issues": [
+          {
+            "expected": null,
+            "input": "2",
+            "kind": "validation",
+            "message": "Invalid UUID: Received "2"",
+            "path": [
+              {
+                "input": {
+                  "id": "2",
+                },
+                "key": "id",
+                "origin": "value",
+                "type": "object",
+                "value": "2",
+              },
+            ],
+            "received": ""2"",
+            "requirement": {},
+            "type": "uuid",
+          },
+        ],
+        "output": {
+          "id": "2",
+        },
+        "success": false,
+        "typed": true,
+      }
+    `)
   })
 })

test/__snapshots__/params.test.ts.snap

@@ -23,7 +23,7 @@ describe('useValidatedQuery', () => {
     const res = await request.get('/validate?required')
 
     expect(res.status).toEqual(200)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toEqual({ required: '' })
   })
 
   it('throws 400 Bad Request if query does not match validation schema', async () => {
@@ -32,7 +32,33 @@ describe('useValidatedQuery', () => {
     const res = await request.get('/validate')
 
     expect(res.status).toEqual(400)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toMatchInlineSnapshot(`
+      {
+        "data": {
+          "issues": [
+            {
+              "expected": "string",
+              "kind": "schema",
+              "message": "Invalid type: Expected string but received undefined",
+              "path": [
+                {
+                  "input": {},
+                  "key": "required",
+                  "origin": "value",
+                  "type": "object",
+                },
+              ],
+              "received": "undefined",
+              "type": "string",
+            },
+          ],
+          "name": "ValiError",
+        },
+        "stack": [],
+        "statusCode": 400,
+        "statusMessage": "Bad Request",
+      }
+    `)
   })
 
   it('doesn\'t throw 400 Bad Request if query does not match validation schema', async () => {
@@ -41,6 +67,6 @@ describe('useValidatedQuery', () => {
     const res = await request.get('/validate')
 
     expect(res.status).toEqual(200)
-    expect(res.body).toMatchSnapshot()
+    expect(res.body).toEqual(v.safeParse(querySchema, {}))
   })
 })