feat: Support entity type mappings

[jimmycallin]

• I have added automatic tests where applicable
• The PR title is suitable as a release note
• The PR contains a description of what has been changed
• The description contains manual test instructions

Changes

Suggestion for alternative implementation of type mapping that don't couple ts-schema-generator and ftrack-api.

Should be as simple as:

import TypeMapping from "./__generated__/schema.ts"
import { Session } from @ftrack/api

const session = new Session<TypeMapping>(...);

const user = await session.query<"User">("...");

This allows easier extension of the types in case they are wrong or the user want to do something weird

Test

[jimmycallin]

this should automatically get the entitytypemap inferred from the provided session, make sure it works so you don't have to specify it explicitly

[jimmycallin]

TEntityType is automatically inferred from the options type, so no need to specify it explicitly (please verify)

[gismya]

That's clever if it works. Needs to be tested. The only issue I see is a lack of verification of the TEntitityType in the Options.

[gismya]

I have a feeling that the extends Record<string,any> will break all the type safety, setting everything to any even if we specify a TEntityTypeMap

[jimmycallin]

you can look at the test/session.test.ts and toy with it a bit, seem to be working:

[ffMathy]

I love where this is going. Way better. Great work!

[gismya]

Seems to be working well. Operations work slightly less well with this structure than the module augmentation one, but I prefer this way of doing it anyways. We just need to add some documentation on how to use it.

[gismya]

Needs to be tested by integrating in our code base before releasing, but my initial tests all look good.

[ffMathy]

This makes me so happy! Thank you!