00:02
So we can create our own rules with VineJS as well. And the documentation does a fantastic job of walking through this.
00:10
And the example that they give is great as well. So we're gonna walk through that in this lesson in the context of AdonisJS. So we're gonna be provided a couple of things whenever we create a rule. We're gonna be provided the value,
00:20
which will be of type unknown. So we're gonna need to discern what the type is before we actually attempt to use it. Options accepted by the rule. These are options that we can define as is.
00:29
So this could be something like a table or a column to check the database to see whether or not a value is unique. That's something defined by us. And if we define the rule to have nothing as options,
00:38
then the second parameter will be undefined. Then comes the field context. This is contextual information about the actual field data. So things like the value, data, metadata,
00:47
whether the field is valid, defined. You can mutate the value, report errors, field parent, name, and whether or not it's an array member. So that's what's confined within the field context.
00:56
So to start, we're going to need a place to house our new validation rule. For this, we'll want to use a preload file. So we can stop our server. Let's clear that out.
01:04
Let's do node ace make reload. We'll put these inside of a directory called rules, and we're gonna follow along with the documentations example. So we'll create a unique rule to simplify the unique checks
01:14
throughout our validation example. Remember, right now within our application, if we dive inside of our auth validator, our unique check looks something like this, where we're taking a callback function
01:24
that's provided into the database, manually compiling out that query, and then returning back whether or not we found results. So we're gonna wrap this up in a pretty little bow, where all that we need to do is provide in the table
01:33
and the column that we want to check, and the check will happen automatically. So let's hide that back away. Let's run that to create our preload. We'll have it register it within our AdonisRC.ts file, and we're good to go there.
01:42
Let's go ahead and boot our server back up while we're here. All right, let's hide that back away and dive into our text editor, and let's head into our new preload file. So that's within our start directory. We created that within a folder called rules,
01:52
and there's our file for unique. Within here, we're gonna want an async function. We'll call this function our rules name. Within the documentation, they call this unique. However, I don't want to overwrite
02:01
the current unique check that we have. We'll leave this in place. So let's name our simplified rule something different, maybe something like is unique.
02:09
Our parameters to this method will then be the value, which as the documentation noted, is of type unknown. So we need to discern what type the actual value holds before we can use it.
02:18
Then options. By default, if we don't want our method to accept any options, this will be undefined. We do want ours to accept options, but just to get us going,
02:27
let's stub that to undefined for right now. And then our field information, which is of type field context, which we can import from vine.js/vine-types.
02:34
Since we're specifically going to use that just as a type, we'll import that as a type there as well. So for our options, let's go ahead and create a type for that. So we'll do type options equals object.
02:44
We'll have one option be our table. So the table that we should check against for the column, this will be a type string, and then the column that we should check against inside of that table.
02:53
Let's jump down to our options and set that as the type value there. The first thing we're going to want to do is check the type of our value. For the documentation, they show this as just being a string
03:02
and they kick out anything that is not a string, but I could see this being used for an ID as well. So I think we'll allow numbers within ours as well.
03:10
So let's do if type of value does not equal string and type of value does not equal number, then we'll just want to return back out of this method so that this particular method
03:20
doesn't handle either of those types. We're going to add our is unique method as an option onto vine string and vine number. So if the value doesn't match one of those two types,
03:28
the vine string or vine number validation will handle that accordingly. So within our actual unique check, we don't need to report the error at this point
03:36
because that vine string or vine number check will take care of that for us. We can just ignore the value here. Then if our value is a string or a number, we can move onward.
03:46
So we'll do const result equals await, and then we're going to want to import the database module because we don't know what particular model we're going to be working with here.
03:53
So we can use the database module to accept in the table that we should check against and hone that in on the particular column to check and see whether or not we have a value.
04:00
So import db from at AdonisJS, Lucid services, db, we can scroll back down and make use of that db query builder.
04:08
So db.from, provide in our options.table, select just the options.column that we want to hone in on
04:15
where that options.column equals the value that's provided in. And then if any of them exist inside of the database, the is unique check will be false.
04:23
So we can just stop at the first found record and get that back as our result. So if we have a result, then we'll want to report that the value is not unique.
04:33
So we'll do field, and then we can use that report method that we saw inside of the documentation to report an error. The first argument here is going to be that error message. The second argument is going to be the rule that failed.
04:43
And then the third argument is going to be the field information for our validation. So for this value, we can do something like this and then reach for interpolation and specify in the field.
04:52
And this would plop something in like this. And then if we're validating an email, this would be this email is already taken or something like that. The rule here is is unique.
05:01
And then the field information we can provide in as the third argument. If this rule is valid, however, we don't want to report an error. And instead we can just escape out of this function
05:11
so we don't need to do anything else. Okay, so we have the function handler for our rule fully defined. Now we need to register it with VineJS. So first thing we're going to want to import find
05:20
from VineJS/find. Scroll back down and let's do const is unique rule equals find. And there's a method on here called create rule
05:29
that will actually create a find validator rule for the function that we provide in. So we'll just want to provide in our is unique function. There, now we've actually created a find rule
05:38
with our is unique method. And the full rule is our is unique rule variable. We could export this so that we could use it as needed elsewhere. But as stated earlier, we could also add this directly
05:48
onto the types that we want this rule to be available for as well, which in our case is both our string and our numbered types. So let's import find string,
05:56
which is the rule set for the find string validator and then find number, which is the same thing for the number validator. Scroll back down and let's do a macro for both of those.
06:05
So we'll do find string first, create a macro called is unique. We'll create a block level function that accepts in this, which is of type find string.
06:13
And this is an instance of the actual validation rule that's being built specifically for the string type. And then the second argument will want to be the actual options that we accept
06:22
into our new is unique validation rule. So that's going to be the options type that we defined at the top of this file. It's defined as a block level function and then return this dot.
06:31
And we can use to push our validation rule into the applied validations for this specific find string instance. So for this use method,
06:40
we'll want to provide in our is unique rule, not the actual is unique function. So we'll do is unique rule. We'll call that as a function and provide the options into it.
06:50
Okay, now we're getting a red squiggly on our is unique string because is unique is not assignable to a parameter uptight key find string because it has not been defined on the actual type set. So we want to do that next.
07:00
So let's declare module at find JS slash bind. Then we'll want to reach for the bind string interface. So bind string there and add in our is unique rule
07:10
and designate that this accepts in options of type options and returns back the validation rule builder of type this. And now we should have that readily available to us.
07:18
Furthermore, if we now dive back into our auth validator, before where we call this unique, let's attempt to do now dot is unique and there is our brand new rule.
07:27
And if we attempt to call it, we'll see that it accepts in our options. So we can provide in our object with a type table. For this, we want to check the users table and provide in the column.
07:36
Then we'll want to check the email column there. So now we should be able to get rid of this big function call and just use our brand new is unique rule. And additionally, we've left that unique method there
07:45
just in case we need it in the future for more expandability. Okay, let's jump back into our unique rule and apply this for our number types as well. It's gonna look very similar to this. The types are just gonna be different.
07:54
So we'll do bind number. This right here will be bind number as well. And then we just want to copy the interface, paste it in here and switch this from bind string to find number.
08:03
And now we have this available for numbers as well as strings. So if we were to try to dive back into our auth validator, let's do something like user ID. This doesn't make much sense,
08:12
but just so that we can actually see that it's available, let's do bind number. That is unique. And there we go. So it's available there as well. But if we do something that we haven't applied it to,
08:20
like remember me, bind Boolean type is unique. It does not exist there. So awesome. Everything's looking a-okay. The last thing to do is to actually test it out and make sure that it works.
08:30
So with our server running, let's head back into our application. Let's jump into our register page because this is where we're actually using that unique check rule. We'll provide John for our first name,
08:38
test@test.com for our email, and then just whatever for the password. And there we go. We got back our error. This email is already taken as we've described it within our brand new custom rule.
08:47
Let's switch this to test2@test.com, which does not exist inside of our database. And let's enter in a valid password, attempt to register, and voila, everything worked a-okay.
08:56
We didn't get any errors with our validation. And we can check our terminal out once more. And we see the actual created user within here as well. So we know everything worked a-okay in terms of our user being created.
