Add typescript definition file

[JaneJeon]

No description provided.

[issue-label-bot]

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.91. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

[geopic]

Hello, I'm looking to contribute to open-source projects by writing type declaration files, can I work on this issue?

[JaneJeon]

@geopic please! You're a lifesaver!

[geopic]

Hello! I have a few queries from the Readme:

1. Under the '@casl/ability' subheading, you have a function named acl with a number of parameters. What kind of arguments are expected from those parameters?

2. Under the 'Options' heading, you have the options object for the objectionAuthorize function. What data type is role supposed to be for user?

Cheers, George

[geopic]

Also in the options object, is undefined in the resourceAugments object always the undefined type?

[JaneJeon]

Ooh, you decided to go with the hard one? @geopic

So whereas the ACL is an instance of a class in case of role-acl, for casl, for @casl/ability, it needs to be a function taking (user, resource, action, body, opts) (and in that order as well) that returns an instance of Ability.

As for question number 2, did you mean roleFromUser? In case of role-acl it needs to take an instance of Objection Model and return a string.

As for the resourceAugments, the true/false/undefined are meant to be "constants" in the ACL namespace, so yes, they're always going to be the javascript true/false/undefined types.

And finally, perhaps the most important thing is making sure that when you call SomeModel.query(), the type points to an instance of our custom query builder (which in itself is a subclass of the base Model's QueryBuilder). It is the most important thing that led me to even create this issue in the first place, because when you're working with the ORM, you're always going to be calling SomeModel.query().blah()... and when the .query() doesn't correctly point to the model's QueryBuilder, everything that is chained to the .query() loses types which leads to a horrible development experience D:

Thankfully, the author of the main ORM managed to put in completely new typings to help with that: http://vincit.github.io/objection.js/recipes/custom-query-builder.html#extending-the-query-builder-in-typescript 🎉

[geopic]

Thanks for the info Jane, I'll ask again if I have any further questions.

Ooh, you decided to go with the hard one?

I've decided to go with both, this one first. 😉

[geopic]

So whereas the ACL is an instance of a class in case of role-acl, for casl, for @casl/ability, it needs to be a function taking (user, resource, action, body, opts) (and in that order as well) that returns an instance of Ability.

What data types are those arguments?

[JaneJeon]

So the thing about this is that user and resource are based on whatever model classes you're using. But at a high level, I guess both are instances of a subclass of the Model class: https://github.com/Vincit/objection.js/blob/master/typings/objection/index.d.ts#L1370

action: string, body: object, and opts is an object that can technically have any argument BUT it's based on defaultOpts (https://github.com/JaneJeon/objection-authorize/blob/master/index.js#L14) and is Object.assign'd with any option you pass per query. @geopic