Releases · vinejs/vine

11 Jul 07:29

thetutlage

v1.5.1

48a3b6a

Fix: Make schema classes Macroable to be extensible

ci: fix failing tests 2f5258c
ci: remove test.yml workflow file 89efc20
test: fix failing tests d04800c
test: add test for extending Vine class a417418
fix: make schema classes Macroable 41bd3d5

Full Changelog: v1.5.0...v1.5.1

Assets 2

10 Jul 11:46

thetutlage

v1.5.0

fa3c782

Add API to make validation metadata type-safe

In VineJS, you can pass runtime metadata to the validation pipeline, which you can access from the validation rules, union predicates, etc. The metadata API was not type-safe until now. However, this release allows you to define the static metadata types and a validation function to validate them at runtime.

Note: The metadata API is kept very simple because only a few schemas might need runtime metadata with a few properties to be functional.

One example is the unique validation rule. You might want the unique validation rule to check all the database rows except the one for the currently logged-in user. In that case, you will pass the currently logged-in userId to the statically compiled validation schema using metadata as follows.

const updateUserValidator = vine.compile(
  vine.object({
    email: vine.string().email().unique((field) => {
      console.log(field.meta.userId)
    }),
  })
)

await updateUserValidator.validate(data, {
  meta: { userId: request.auth.user.id }
})

However, there is no way to know that updateUserValidator needs the currently logged-in user id to be functional.

From @vinejs/vine@1.5.0, you can use the withMetaData method to define static types for the metadata a validator accepts. The schema will look as follows.

const updateUserValidator = vine
  .withMetaData<{ userId: number }>()
  .compile(
    vine.object({
      email: vine.string().email().unique((field) => {
        console.log(field.meta.userId)
      }),
    })
  )

You can pass a callback to withMetaData to validate the metadata at runtime if needed.

vine
  .withMetaData<{ userId: number }>((meta) => {
    // validate id and throw an error
 })

Commits

feat: add support for defining static metadata types and validator function 09c4097
chore: use @adonisjs/tooling presets for tooling config a02908d
chore: upgrade japa to v3 4181ee4
chore: update dependencies f24ebb8
chore: add labels to exempt from stale and lock bot 92697c4
docs: fix contributing link fcad2fb