Nested `relationships` in `PaginateConfig` not working

[Helveg]

Nested `relationships` in `PaginateConfig` not working

[ppetzold]

try relations: { any: { nested: { relation: true } } }

[Helveg]

It doesn't appear to work, no error is thrown but no nested relationships are loaded either:

      async findAll(@Paginate() query: PaginateQuery) {
        return await paginate(query, this.service.repo, {
          ...this.options.pagination,
          relations: {bankAccount: {organization: true}}
        });
      }

but the returned page is:

Paginated {
  data: [
    Payout {
      id: 'b18b40f3-08ac-428e-9712-ada46fd0a4a5',
      createdAt: 2023-09-07T14:50:43.000Z,
      updatedAt: 2023-09-07T14:50:43.000Z,
      deletedAt: null,
      amount: null,
      paidAt: null
    },
...

Passing that same nested object {bankAccount: { organization: true } } to a TypeORM relations field does load the relationships.

In any case, after figuring this out, would you accept a PR that lets users use the dotted notation as well?

[ppetzold]

In any case, after figuring this out, would you accept a PR that lets users use the dotted notation as well?

Yep. Certainly, I actually thought the above was an alternate typeORM definition as well. If not, then I would almost say we drop it and adapt the typeORM way only in a breaking change.

[Helveg]

The problem was resolved by updating my version (sorry about that).

I also reviewed the TypeORM docs and the object notation is the the only mentioned notation. On StackOverflow users answer with both, so somehow this dotted notation does circulate. I'd propose for my support to add non-breaking support for the dot notation then.

The dot notation (relations: string[]) does have official support, and we could use the same utility snippet they use to convert between them:

                const relations = Array.isArray(this.findOptions.relations)
                    ? OrmUtils.propertyPathsToTruthyObject(
                          this.findOptions.relations,
                      )
                    : this.findOptions.relations

https://github.com/typeorm/typeorm/blob/befe4f9cbf17139bfaba83ae8a00e56b071df334/src/query-builder/SelectQueryBuilder.ts#L3097-L3101

I'll start on the PR

[ppetzold]

sounds good to me 🚀

[ppetzold]

🎉 This issue has been resolved in version 8.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀