Bug: TypeError on SortBuildInput

[Xavier-IV]

Receiving this error while using this package as a dependent to typeorm-extension package.

Type 'Flatten<T[K]>' does not satisfy the constraint 'Record<string, any>'.
  Type 'unknown' is not assignable to type 'Record<string, any>'.

9     [K in keyof T]?: T[K] extends OnlyScalar<T[K]> ? `${SortDirection}` : T[K] extends Date ? `${SortDirection}` : T[K] extends OnlyObject<T[K]> ? SortBuildInput<Flatten<T[K]>> | SortWithOperator<Flatten<T[K]>> : never;

Versions

• Node: 14.8.2
• OS: MacOS Monterey, i7
• TSC: 4.5.5

Reproduction

Additional Details

Upon compiling our application using tsc, we are thrown with the error stated above.

Steps to reproduce

What is Expected?

Error should not be thrown on typescript compilation.

What is actually happening?

We might have a solution for this. Changing this line seems to resolve the issue:

rapiq/src/parameter/sort/type.ts

Line 26 in fa5590e

export type SortBuildInput<T> = {

Suggested Change:

export declare type SortBuildInput<T extends Record<string, any>> = {
    [K in keyof T]?: T[K] extends OnlyScalar<T[K]> ? `${SortDirection}` : T[K] extends Date ? `${SortDirection}` : T[K] extends OnlyObject<T[K]> ? SortBuildInput<Flatten<T[K]>> | SortWithOperator<Flatten<T[K]>> : never;
} | SortWithOperator<T>;

extending T with Record<string, any> does resolve it, but I am unsure if this was the initial author intention.

[tada5hi]

good catch 💪, thank you very much 👍

[Xavier-IV]

Thanks!

Might want to bump the npm version as well to include the smallfix, I'm not sure if that's something can be done via github

ps: typeorm-extension might want to bump dependencies version of this package too

[tada5hi]

bumped the version of both packages ✌️
I hope that everything is now wokring for you 😊 .
If you have any other ideas or suggestions for improvement, I would be happy to receive further contributions.

Ps: Would be great if you would follow the guideline for conventional commits in the future.

[Xavier-IV]

bumped the version of both packages ✌️ I hope that everything is now wokring for you 😊 . If you have any other ideas or suggestions for improvement, I would be happy to receive further contributions.

Ps: Would be great if you would follow the guideline for conventional commits in the future.

Thanks! Yes, appreciate you sharing the guideline.

Will be helpful in future contributions. Awesome works!