Fix for TS create declarations when updating (v10)

[steffenagger]

Main goal

Initiated based on this comment: #3044 (comment) - v6 PR can be found here: #3271

Allow for partial models when using Realm.UpdateMode.All or Realm.UpdateMode.Modified

Create declarations has been updated to:

/** ... */
create<T>(type: string, properties: RealmInsertionModel<T>, mode?: Realm.UpdateMode.Never): T & Realm.Object;
create<T>(type: string, properties: Partial<T> | Partial<RealmInsertionModel<T>>, mode: Realm.UpdateMode.All | Realm.UpdateMode.Modified): T & Realm.Object;

/** ... */
create<T extends Realm.Object>(type: {new(...arg: any[]): T; }, properties: RealmInsertionModel<T>, mode?: Realm.UpdateMode.Never): T;
create<T extends Realm.Object>(type: {new(...arg: any[]): T; }, properties: Partial<T> | Partial<RealmInsertionModel<T>>, mode: Realm.UpdateMode.All | Realm.UpdateMode.Modified): T;

Deprecated declarations has been removed after agreement with @kneth
Any better way of achieving the above?

Additional changes

I extended integration-tests for object creation/reading to include update-tests & test for Class Models (these additions only works in combination with #3262 - now rebased on v10 efter merge).

And fixed an issue with serialization tests (so it now works in different environments - the previous error message check was a bit too specific, as described here (MDN)).

Update

objectForPrimaryKey updated to:
(to align with the existing declarations for objects<T>(...) - tests for this added)

/** ... */
objectForPrimaryKey<T>(type: string, key: number | string | Realm.ObjectId): (T & Realm.Object) | undefined;

/** ... */
objectForPrimaryKey<T extends Realm.Object>(type: {new(...arg: any[]): T; }, key: number | string | Realm.ObjectId): T | undefined;

The above change limits the use of realm.objectForPrimaryKey(Person) to only accept Class Model which extends Realm.Object (just like objects<T>(...) is currently declared).

☑️ ToDos

• 📝 Changelog entry
• 🚦 Tests

If this PR adds or changes public API's:

• typescript definitions file is updated
• jsdoc files updated
• Chrome debug API is updated if API is available on React Native

[blagoev]

maybe we can improve a bit