Missing properties $, get when using ref method

[sawa-ko]

Describe the bug
I am currently trying to relate that property to an entity but I get the typescript error saying that the $ and get properties are missing. According to the documentation this is how it should be done, but I get this typescript error.

// Profile Entity
@ManyToOne({ entity: () => ProfileBagBackgrounds, wrappedReference: true, nullable: true })
public background: Ref<ProfileBagBackgrounds, 'id' | '_id'> | null = null;

// ProfileBagBackgrounds Entity
@Entity({ collection: 'profile_bag_backgrounds' })
export class ProfileBagBackgrounds extends ProfileBag {
	@ManyToOne(() => ProfileShopBackgrounds)
	public item!: ProfileShopBackgrounds;
}

// Types
user: MongoEntityRepository<ProfileEntity>;
bags: {
	backgrounds: MongoEntityRepository<ProfileBagBackgrounds>;
};

// Query
const item = await this.container.database.entities.user.profile.bags.backgrounds.findOne({ id: item_id });
const userProfile = await this.container.database.entities.user.profile.user.findOneOrFail(
	{ user_id: req.session?.data.user.user?.id },
	{ cache: Time.Second * 30, populate: ['banner', 'color', 'background', 'sticker'] }
);

// Error
import { ref } from '@mikro-orm/core';
userProfile.background = ref(item);

Stack trace

Type '{ init: <Populate extends string = never>(populated?: boolean | undefined) => Promise<Loaded<BaseEntity, Populate>>; id: string; _id: ObjectId; [OptionalProps]: "created_at" | ... 1 more ... | undefined; ... 13 more ...; setSchema: (schema?: string | undefined) => void; } & Reference<...>' is not assignable to type '({ id: string; _id: ObjectId; } & Reference<ProfileBagBackgrounds> & LoadedReference<Loaded<ProfileBagBackgrounds | null, never>>) | null'.
  Type '{ init: <Populate extends string = never>(populated?: boolean | undefined) => Promise<Loaded<BaseEntity, Populate>>; id: string; _id: ObjectId; [OptionalProps]: "created_at" | ... 1 more ... | undefined; ... 13 more ...; setSchema: (schema?: string | undefined) => void; } & Reference<...>' is not assignable to type '{ id: string; _id: ObjectId; } & Reference<ProfileBagBackgrounds> & LoadedReference<Loaded<ProfileBagBackgrounds | null, never>>'.
    Type '{ init: <Populate extends string = never>(populated?: boolean | undefined) => Promise<Loaded<BaseEntity, Populate>>; id: string; _id: ObjectId; [OptionalProps]: "created_at" | ... 1 more ... | undefined; ... 13 more ...; setSchema: (schema?: string | undefined) => void; } & Reference<...>' is missing the following properties from type 'LoadedReference<Loaded<ProfileBagBackgrounds | null, never>>': $, get ts(2322)

To Reproduce
Steps to reproduce the behavior:

1. Create and entity with Ref type
2. Query and get an entity
3. Try to create a reference of this entity to the property

Expected behavior
No type error as according to the documentation this is the way it should be done.

Additional context
No.

Versions

Dependency	Version
node	18.12.1
typescript	4.8.4
mikro-orm	5.5.3
your-driver	mongo

[B4nan]

ref(item) just creates reference wrapper instance (Reference class), that itself does not mean it will have $ property available on type level (it is always there on runtime) - you need to have a populate hint for that to work, its purely type information driven by populate hints. In other words, ref() will not return a LoadedReference, which your userProfile.background is typed to.

import { ref } from '@mikro-orm/core';
userProfile.background = ref(item) as LoadedReference<your entity type>;

I guess it makes sense to return the LoadedReference from there, at least when you wrap existing entity instance, will see if it won't break existing tests.

[B4nan]

This should do it:

c85e507