find* methods include navigational properties

[nabdelgadir]

Resolves #2632.

• find and findById now use T & Relations instead of T
• New prompt for lb4 model that asks for relations in order to create the relation interface (e.g. export interface TodoRelations {}). It leaves it empty if there are no current relations.
• Newly scaffolded models from lb4 model include {modelName}WithRelations type (e.g. export type TodoWithRelations = Todo & TodoRelations;)
• Generic parameter Relations added to DefaultCrudRepository
• When scaffolding a repository with lb4 repository, it now includes {modelName}Relations (e.g.

export class TodoListRepository extends DefaultCrudRepository<
  TodoList,
  typeof TodoList.prototype.id
  TodoListRelations
> 

)

Question: should all models include a relations interface? If so, I'll update the examples/docs.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• API Documentation in code was updated
• Documentation in /docs/site was updated
• Affected artifact templates in packages/cli were updated
• Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

[bajtos]

Great start!

I feel the changes in CLI are going in wrong direction and adding unnecessary complexity, let's discuss.

[bajtos]

Almost there!

In the new commits, I added empty interfaces because I think they should be populated only after #2633 is landed. What do you think?

I am not sure if I understand your question correctly.

IMO, when a model already has some relations defined, then the *Relations interface should have the navigational properties defined too. We will need these navigational properties for our next steps on the journey to implement the feature "inclusion of related models".

As I see it, #2633 is about automating the task of adding navigational properties. Until it's done, developers will have to define these properties manually, which is exactly what I am asking you to do in this pull request too.

[nabdelgadir]

@bajtos

IMO, when a model already has some relations defined, then the *Relations interface should have the navigational properties defined too. We will need these navigational properties for our next steps on the journey to implement the feature "inclusion of related models".

As I see it, #2633 is about automating the task of adding navigational properties. Until it's done, developers will have to define these properties manually, which is exactly what I am asking you to do in this pull request too.

I thought the purpose of #2633 was only to add them to the TodoList example and verify it works for that example (and then after it's tested there, then we could add the properties of the *Relations interface to the other examples/docs). But I guess adding them here makes more sense, so now they're a part of this PR 👍

Also, did you mean #2988 was for automating instead of #2633?

[bajtos]

Also, did you mean #2988 was for automating instead of #2633?

Yes, I meant #2988. Sorry for the confusion!

[bajtos]

LGTM 👏

[b-admike]

Nice 👏 LGTM.