Is it possible to enforce the structure of the block route object (with TypeScript)?

[lamereactor]

Let's say I have this code :

<route lang="json">
{
  name: 'custom-name',
  meta: {
    requiresAuth: true,
    permission: 'admin'
  },
}
</route>

I would like to get a build-time error if, for example:

• name is not defined or is not a string
• meta.requiresAuth is not defined or is not a boolean
• meta.permission is not defined or is not one of the strings 'admin', 'user', or 'guest'

Is it possible to throw a build-time error if the object’s structure doesn’t match a given TypeScript type or something like that?

@posva tagging you as this relates to the recent addition of unplugged-vue-router — would really appreciate your insight. Thanks!

[posva]

It's probably possible but I don't know how, maybe with a json schema and a ts plugin. You could also do

definePage({
// ...
} satisfies MyStrictType)

[lamereactor]

Thank you for your reply, I’m going to explore these options.

Could you also let me know whether it’s possible to use variables (or something similar) in route blocks?
I haven’t seen anything like that, and I assume it would also require a custom-made solution.

For example :

<route lang="json">
{
  name: 'custom-name',
  meta: {
    requiresAuth: true,
    permission: SomeEnum.Admin
  },
}
</route>