Make counter types requirable

packages/realm/src/Object.ts

@@ -27,10 +27,11 @@
   JSONCacheMap,
   ObjectChangeCallback,
   ObjectListeners,
   OmittedRealmTypes,
   OrderedCollection,
   Realm,
   RealmObjectConstructor,
+  RequirableProperties,
   Results,
   TypeAssertionError,
   TypeHelpers,
@@ -144,7 +145,7 @@
  * }
  * ```
  * @see {@link ObjectSchema}
  * @typeParam `T` - The type of this class (e.g. if your class is `Person`,
  * `T` should also be `Person` - this duplication is required due to how
  * TypeScript works)
  * @typeParam `RequiredProperties` - The names of any properties of this
@@ -152,7 +153,7 @@
  * properties not specified will be optional, and will default to a sensible
  * null value if no default is specified elsewhere.
  */
-export class RealmObject<T = DefaultObject, RequiredProperties extends keyof OmittedRealmTypes<T> = never> {
+export class RealmObject<T = DefaultObject, RequiredProperties extends keyof RequirableProperties<T> = never> {
   /**
    * This property is stored on the per class prototype when transforming the schema.
    * @internal

packages/realm/src/Unmanaged.ts

@@ -61,9 +61,13 @@
 /**
  * Exchanges properties defined as a {@link Counter} with a `number`.
  */
-type RealmCounterRemappedModelPart<T> = {
-  [K in ExtractPropertyNamesOfTypeExcludingNullability<T, Counter>]?: Counter | number | Exclude<T[K], Counter>;
-};
+type RealmCounterRemappedModelPart<T, RequiredProperties extends keyof RequirableProperties<T>> = OptionalExceptRequired<T, {
+  [K in ExtractPropertyNamesOfTypeExcludingNullability<T, Counter>]: Counter | number | Exclude<T[K], Counter>;
+}, RequiredProperties>;
+
+type RealmObjectRemappedModelPart<T, RequiredProperties extends keyof RequirableProperties<T>> = OptionalExceptRequired<T, {
+  [K in ExtractPropertyNamesOfTypeExcludingNullability<T, Realm.Object<any>>]: Unmanaged<T[K]> | undefined | null;
+}, RequiredProperties>;
 
 /** Omits all properties of a model which are not defined by the schema */
 export type OmittedRealmTypes<T> = Omit<
@@ -74,33 +78,39 @@
   | ExtractPropertyNamesOfType<T, AnyCollection>
   | ExtractPropertyNamesOfType<T, AnyDictionary>
   | ExtractPropertyNamesOfTypeExcludingNullability<T, Counter>
+  | ExtractPropertyNamesOfTypeExcludingNullability<T, Realm.Object<any>>
 >;
 
-/** Make all fields optional except those specified in K */
-type OptionalExcept<T, K extends keyof T> = Partial<T> & Pick<T, K>;
+export type RequirableProperties<T> = Omit<T, keyof AnyRealmObject>;
+
+/** Make all fields optional except those specified in RequiredProperties */
+type OptionalExceptRequired<T, TPart, RequiredProperties extends keyof RequirableProperties<T>> = Partial<TPart> & Pick<TPart, RequiredProperties & keyof TPart>;
 
 /**
  * Omits all properties of a model which are not defined by the schema,
  * making all properties optional except those specified in RequiredProperties.
  */
-type OmittedRealmTypesWithRequired<T, RequiredProperties extends keyof OmittedRealmTypes<T>> = OptionalExcept<
+type OmittedRealmTypesWithRequired<T, RequiredProperties extends keyof RequirableProperties<T>> = OptionalExceptRequired<
+  T,
   OmittedRealmTypes<T>,
   RequiredProperties
 >;
 
 /** Remaps realm types to "simpler" types (arrays and objects) */
-type RemappedRealmTypes<T> = RealmListRemappedModelPart<T> &
-  RealmDictionaryRemappedModelPart<T> &
-  RealmSetRemappedModelPart<T> &
-  RealmCounterRemappedModelPart<T>;
+type RemappedRealmTypes<T, RequiredProperties extends keyof RequirableProperties<T>> =
+  & RealmListRemappedModelPart<T>
+  & RealmDictionaryRemappedModelPart<T>
+  & RealmSetRemappedModelPart<T>
+  & RealmCounterRemappedModelPart<T, RequiredProperties>
+  & RealmObjectRemappedModelPart<T, RequiredProperties>;
 
 /**
  * Joins `T` stripped of all keys which value extends {@link Collection} and all inherited from {@link Realm.Object},
  * with only the keys which value extends {@link List}, remapped as {@link Array}. All properties are optional
  * except those specified in `RequiredProperties`.
  */
-export type Unmanaged<T, RequiredProperties extends keyof OmittedRealmTypes<T> = never> = OmittedRealmTypesWithRequired<
+export type Unmanaged<T, RequiredProperties extends keyof RequirableProperties<T> = never> = OmittedRealmTypesWithRequired<
   T,
   RequiredProperties
 > &
-  RemappedRealmTypes<T>;
+  RemappedRealmTypes<T, RequiredProperties>;