fix: mikro-orm v6 typings

darkbasic · darkbasic · commit e9ae0e56beb2 · 2023-11-10T15:57:35.000+01:00
diff --git a/examples/graphql-server-mikro-orm-postgres/src/entities/email.ts b/examples/graphql-server-mikro-orm-postgres/src/entities/email.ts
@@ -7,21 +7,19 @@ import {
 import { Entity, Property } from '@mikro-orm/core';
 import { User } from './user';
 
-const AccountsEmail: EmailCtor<User> = getEmailCtor<User>({ abstract: true });
-
 export type EmailCtorArgs = AccountsEmailCtorArgs<User> & {
-  fullName?: string;
+  fullName: string;
 };
 
+const AccountsEmail: EmailCtor<User> = getEmailCtor<User>({ abstract: true });
+
 @Entity()
 export class Email extends AccountsEmail {
-  @Property({ nullable: true })
-  fullName?: string;
+  @Property()
+  fullName: string;
 
   constructor({ fullName, ...otherProps }: EmailCtorArgs) {
     super(otherProps);
-    if (fullName) {
-      this.fullName = fullName;
-    }
+    this.fullName = fullName;
   }
 }
diff --git a/examples/graphql-server-mikro-orm-postgres/src/entities/user.ts b/examples/graphql-server-mikro-orm-postgres/src/entities/user.ts
@@ -3,7 +3,6 @@ import {
   UserCtorArgs as AccountsUserCtorArgs,
   Session,
   Service,
-  ServiceCtorArgs,
   UserCtor,
   getUserCtor,
 } from '@accounts/mikro-orm';
@@ -12,21 +11,15 @@ import { Email, EmailCtorArgs } from './email';
 
 type UserCtorArgs = AccountsUserCtorArgs & {
   firstName: string;
-  lastName: string;
+  lastName?: string;
 };
 
-export const AccountsUser: UserCtor<
-  Email,
-  Session<User>,
-  Service<User>,
-  UserCtorArgs
-> = getUserCtor<
+export const AccountsUser: UserCtor<Email, Session<User>, Service<User>> = getUserCtor<
   Email,
   Session<User>,
   Service<User>,
   UserCtorArgs,
-  EmailCtorArgs,
-  ServiceCtorArgs<User>
+  EmailCtorArgs
 >({
   abstract: true,
   EmailEntity: Email,
@@ -37,18 +30,15 @@ export const AccountsUser: UserCtor<
 
 @Entity()
 export class User extends AccountsUser {
-  @Property({ nullable: true })
-  firstName?: string;
+  @Property()
+  firstName: string;
 
   @Property({ nullable: true })
   lastName?: string;
 
-  constructor(args: UserCtorArgs) {
-    super(args);
-    const { firstName, lastName } = args;
-    if (firstName) {
-      this.firstName = firstName;
-    }
+  constructor({ firstName, lastName, ...otherProps }: UserCtorArgs) {
+    super(otherProps);
+    this.firstName = firstName;
     if (lastName) {
       this.lastName = lastName;
     }
diff --git a/packages/database-mikro-orm/src/entity/Email.ts b/packages/database-mikro-orm/src/entity/Email.ts
@@ -1,10 +1,10 @@
-import { Ref, Reference, EntitySchema } from '@mikro-orm/core';
+import { Reference, EntitySchema, ref } from '@mikro-orm/core';
 import { IUser, UserCtor } from './User';
 
 export class Email<CustomUser extends IUser<any, any, any>> {
   id!: number;
 
-  user!: Ref<CustomUser>;
+  user!: Reference<CustomUser> & { id: number };
 
   address: string;
 
@@ -13,7 +13,7 @@ export class Email<CustomUser extends IUser<any, any, any>> {
   constructor({ address, user, verified }: EmailCtorArgs<CustomUser>) {
     this.address = address.toLocaleLowerCase();
     if (user) {
-      this.user = Reference.create(user);
+      this.user = ref(user);
     }
     if (verified) {
       this.verified = verified;
@@ -27,19 +27,23 @@ export interface EmailCtorArgs<CustomUser extends IUser<any, any, any>> {
   verified?: boolean;
 }
 
-export type EmailCtor<CustomUser extends IUser<any, any, any>> = new (
-  args: EmailCtorArgs<CustomUser>
-) => Email<CustomUser>;
+export type EmailCtor<
+  CustomUser extends IUser<any, any, any>,
+  CustomEmailCtorArgs extends EmailCtorArgs<CustomUser> = EmailCtorArgs<CustomUser>,
+> = new (args: CustomEmailCtorArgs) => Email<CustomUser>;
 
-export const getEmailCtor = <CustomUser extends IUser<any, any, any>>({
+export const getEmailCtor = <
+  CustomUser extends IUser<any, any, any>,
+  CustomEmailCtorArgs extends EmailCtorArgs<CustomUser> = EmailCtorArgs<CustomUser>,
+>({
   abstract = false,
 }: {
   abstract?: boolean;
-} = {}): EmailCtor<CustomUser> => {
+} = {}): EmailCtor<CustomUser, CustomEmailCtorArgs> => {
   if (abstract) {
     Object.defineProperty(Email, 'name', { value: 'AccountsEmail' });
   }
-  return Email as EmailCtor<CustomUser>;
+  return Email as EmailCtor<CustomUser, CustomEmailCtorArgs>;
 };
 
 export const getEmailSchema = ({
diff --git a/packages/database-mikro-orm/src/entity/Service.ts b/packages/database-mikro-orm/src/entity/Service.ts
@@ -1,10 +1,10 @@
-import { Ref, Reference, EntitySchema } from '@mikro-orm/core';
+import { Reference, EntitySchema, ref } from '@mikro-orm/core';
 import { IUser, UserCtor } from './User';
 
 export class Service<CustomUser extends IUser<any, any, any>> {
   id!: number;
 
-  user!: Ref<CustomUser>;
+  user!: Reference<CustomUser> & { id: number };
 
   name: string;
 
@@ -16,7 +16,7 @@ export class Service<CustomUser extends IUser<any, any, any>> {
     this.name = name;
 
     if (user) {
-      this.user = Reference.create(user);
+      this.user = ref(user);
     }
 
     if (password) {
@@ -31,19 +31,23 @@ export type ServiceCtorArgs<CustomUser extends IUser<any, any, any>> = {
   password?: string;
 };
 
-export type ServiceCtor<CustomUser extends IUser<any, any, any>> = new (
-  args: ServiceCtorArgs<CustomUser>
-) => Service<CustomUser>;
+export type ServiceCtor<
+  CustomUser extends IUser<any, any, any>,
+  CustomServiceCtorArgs extends ServiceCtorArgs<CustomUser> = ServiceCtorArgs<CustomUser>,
+> = new (args: CustomServiceCtorArgs) => Service<CustomUser>;
 
-export const getServiceCtor = <CustomUser extends IUser<any, any, any>>({
+export const getServiceCtor = <
+  CustomUser extends IUser<any, any, any>,
+  CustomServiceCtorArgs extends ServiceCtorArgs<CustomUser> = ServiceCtorArgs<CustomUser>,
+>({
   abstract = false,
 }: {
   abstract?: boolean;
-} = {}): ServiceCtor<CustomUser> => {
+} = {}): ServiceCtor<CustomUser, CustomServiceCtorArgs> => {
   if (abstract) {
     Object.defineProperty(Service, 'name', { value: 'AccountsService' });
   }
-  return Service as ServiceCtor<CustomUser>;
+  return Service as ServiceCtor<CustomUser, CustomServiceCtorArgs>;
 };
 
 export const getServiceSchema = ({
diff --git a/packages/database-mikro-orm/src/entity/Session.ts b/packages/database-mikro-orm/src/entity/Session.ts
@@ -1,4 +1,4 @@
-import { Ref, Reference, EntitySchema } from '@mikro-orm/core';
+import { Reference, EntitySchema, ref } from '@mikro-orm/core';
 import { IUser, UserCtor } from './User';
 
 export class Session<CustomUser extends IUser<any, any, any>> {
@@ -8,7 +8,7 @@ export class Session<CustomUser extends IUser<any, any, any>> {
 
   updatedAt: Date = new Date();
 
-  user: Ref<CustomUser>;
+  user: Reference<CustomUser> & { id: number };
 
   token: string;
 
@@ -21,7 +21,7 @@ export class Session<CustomUser extends IUser<any, any, any>> {
   extra?: object;
 
   constructor({ user, token, valid, userAgent, ip, extra }: SessionCtorArgs<CustomUser>) {
-    this.user = Reference.create(user);
+    this.user = ref(user);
     this.token = token;
     this.valid = valid;
     if (userAgent) {
@@ -45,19 +45,23 @@ export type SessionCtorArgs<CustomUser extends IUser<any, any, any>> = {
   extra?: object;
 };
 
-export type SessionCtor<CustomUser extends IUser<any, any, any>> = new (
-  args: SessionCtorArgs<CustomUser>
-) => Session<CustomUser>;
+export type SessionCtor<
+  CustomUser extends IUser<any, any, any>,
+  CustomSessionCtorArgs extends SessionCtorArgs<CustomUser> = SessionCtorArgs<CustomUser>,
+> = new (args: CustomSessionCtorArgs) => Session<CustomUser>;
 
-export const getSessionCtor = <CustomUser extends IUser<any, any, any>>({
+export const getSessionCtor = <
+  CustomUser extends IUser<any, any, any>,
+  CustomSessionCtorArgs extends SessionCtorArgs<CustomUser> = SessionCtorArgs<CustomUser>,
+>({
   abstract = false,
 }: {
   abstract?: boolean;
-} = {}): SessionCtor<CustomUser> => {
+} = {}): SessionCtor<CustomUser, CustomSessionCtorArgs> => {
   if (abstract) {
     Object.defineProperty(Session, 'name', { value: 'AccountsSession' });
   }
-  return Session as SessionCtor<CustomUser>;
+  return Session as SessionCtor<CustomUser, CustomSessionCtorArgs>;
 };
 
 export const getSessionSchema = ({
diff --git a/packages/database-mikro-orm/src/entity/User.ts b/packages/database-mikro-orm/src/entity/User.ts
@@ -19,12 +19,12 @@ export interface IUser<
 }
 
 export const getUserCtor = <
-  CustomEmail extends Email<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomSession extends Session<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomService extends Service<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomUserCtorArgs extends UserCtorArgs,
-  CustomEmailCtorArgs extends EmailCtorArgs<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomServiceCtorArgs extends ServiceCtorArgs<IUser<CustomEmail, CustomSession, CustomService>>,
+  CustomEmail extends Email<any>,
+  CustomSession extends Session<any>,
+  CustomService extends Service<any>,
+  CustomUserCtorArgs extends UserCtorArgs = UserCtorArgs,
+  CustomEmailCtorArgs extends EmailCtorArgs<any> = EmailCtorArgs<any>,
+  CustomServiceCtorArgs extends ServiceCtorArgs<any> = ServiceCtorArgs<any>,
 >({
   abstract = false,
   EmailEntity = Email as new (args: CustomEmailCtorArgs) => CustomEmail,
@@ -72,7 +72,7 @@ export const getUserCtor = <
   if (abstract) {
     Object.defineProperty(User, 'name', { value: 'AccountsUser' });
   }
-  return User as UserCtor<CustomEmail, CustomSession, CustomService, CustomUserCtorArgs>;
+  return User as UserCtor<CustomEmail, CustomSession, CustomService, UserCtorArgs>;
 };
 
 export interface UserCtorArgs {
@@ -82,10 +82,10 @@ export interface UserCtorArgs {
 }
 
 export type UserCtor<
-  CustomEmail extends Email<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomSession extends Session<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomService extends Service<IUser<CustomEmail, CustomSession, CustomService>>,
-  CustomUserCtorArgs extends UserCtorArgs,
+  CustomEmail extends Email<any>,
+  CustomSession extends Session<any>,
+  CustomService extends Service<any>,
+  CustomUserCtorArgs extends UserCtorArgs = UserCtorArgs,
 > = new (args: CustomUserCtorArgs) => IUser<CustomEmail, CustomSession, CustomService>;
 
 export const getUserSchema = ({
@@ -96,9 +96,9 @@ export const getUserSchema = ({
   abstract = false,
 }: {
   AccountsUser: UserCtor<any, any, any, any>;
-  EmailEntity?: EmailCtor<InstanceType<typeof AccountsUser>>;
-  SessionEntity?: SessionCtor<InstanceType<typeof AccountsUser>>;
-  ServiceEntity?: ServiceCtor<InstanceType<typeof AccountsUser>>;
+  EmailEntity?: EmailCtor<any, any>;
+  SessionEntity?: SessionCtor<any, any>;
+  ServiceEntity?: ServiceCtor<any, any>;
   abstract?: boolean;
 }) => {
   if (abstract) {
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "target": "es2019",
-    "lib": ["es2019"],
+    "target": "es2022",
+    "lib": ["es2023"],
     "module": "commonjs",
     "moduleResolution": "node",
     "sourceMap": true,
