refactor: update emitter parameter type to be EmitterLike

adonisjs · Dec 25, 2023 · c7bcb24 · c7bcb24
1 parent fa0eff4
commit c7bcb24
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 18 deletions.
diff --git a/providers/mail_provider.ts b/providers/mail_provider.ts
@@ -9,7 +9,6 @@
 
 import { configProvider } from '@adonisjs/core'
 import { RuntimeException } from '@poppinss/utils'
-import type { Emitter } from '@adonisjs/core/events'
 import type { ApplicationService } from '@adonisjs/core/types'
 
 import { MailManager, Mailer, Message } from '../index.js'
@@ -61,7 +60,7 @@ export default class MailProvider {
         )
       }
 
-      return new MailManager(emitter as unknown as Emitter<MailEvents>, config)
+      return new MailManager(emitter, config)
     })
 
     this.app.container.bind(Mailer, async (resolver) => {

diff --git a/src/fake_mailer.ts b/src/fake_mailer.ts
@@ -9,7 +9,7 @@
 
 import string from '@poppinss/utils/string'
 import { AssertionError } from 'node:assert'
-import type { Emitter } from '@adonisjs/core/events'
+import type { EmitterLike } from '@adonisjs/core/types/events'
 import type { SentMessageInfo } from 'nodemailer/lib/json-transport/index.js'
 
 import { Mailer } from './mailer.js'
@@ -511,7 +511,7 @@ export class FakeMailer extends Mailer<JSONTransport> implements MailerContract<
   mails = new MailsCollection()
   messages = new MessagesCollection()
 
-  constructor(name: string, emitter: Emitter<MailEvents>, config: MailerConfig) {
+  constructor(name: string, emitter: EmitterLike<MailEvents>, config: MailerConfig) {
     super(name, new JSONTransport(), emitter, config)
     super.setMessenger({
       queue: async (mail, sendConfig) => {

diff --git a/src/mail_manager.ts b/src/mail_manager.ts
@@ -8,7 +8,7 @@
  */
 
 import { RuntimeException } from '@poppinss/utils'
-import type { Emitter } from '@adonisjs/core/events'
+import type { EmitterLike } from '@adonisjs/core/types/events'
 
 import debug from './debug.js'
 import { Mailer } from './mailer.js'
@@ -28,7 +28,7 @@ import type {
  * their lifecycle and switch between them.
  */
 export class MailManager<KnownMailers extends Record<string, MailManagerTransportFactory>> {
-  #emitter: Emitter<MailEvents>
+  #emitter: EmitterLike<MailEvents>
 
   /**
    * Messenger to use on all mailers created
@@ -47,7 +47,7 @@ export class MailManager<KnownMailers extends Record<string, MailManagerTranspor
   #mailersCache: Partial<Record<keyof KnownMailers, Mailer<MailTransportContract>>> = {}
 
   constructor(
-    emitter: Emitter<MailEvents>,
+    emitter: EmitterLike<MailEvents>,
     public config: MailerConfig & {
       default?: keyof KnownMailers
       mailers: KnownMailers

diff --git a/src/mailer.ts b/src/mailer.ts
@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 
-import type { Emitter } from '@adonisjs/core/events'
+import type { EmitterLike } from '@adonisjs/core/types/events'
 
 import debug from './debug.js'
 import { Message } from './message.js'
@@ -32,7 +32,7 @@ export class Mailer<Transport extends MailTransportContract> implements MailerCo
   /**
    * Reference to AdonisJS application emitter
    */
-  #emitter: Emitter<MailEvents>
+  #emitter: EmitterLike<MailEvents>
 
   /**
    * Messenger to use for queuing emails
@@ -42,8 +42,8 @@ export class Mailer<Transport extends MailTransportContract> implements MailerCo
   constructor(
     public name: string,
     public transport: Transport,
-    emitter: Emitter<MailEvents>,
-    public config: MailerConfig
+    emitter: EmitterLike<MailEvents>,
+    public config: MailerConfig = {}
   ) {
     this.#emitter = emitter
     this.#messenger = new MemoryQueueMessenger(this, this.#emitter)

diff --git a/src/messengers/memory_queue.ts b/src/messengers/memory_queue.ts
@@ -8,7 +8,7 @@
  */
 
 import fastq, { type done } from 'fastq'
-import type { Emitter } from '@adonisjs/core/events'
+import type { EmitterLike } from '@adonisjs/core/types/events'
 
 import debug from '../debug.js'
 import type { MailResponse } from '../mail_response.js'
@@ -43,7 +43,7 @@ function sendEmail(
  * emails within memory and send them in the chunks of 10
  */
 export class MemoryQueueMessenger implements MailerMessenger {
-  #emitter: Emitter<MailEvents>
+  #emitter: EmitterLike<MailEvents>
   #queue = fastq(this, sendEmail, 10)
   #jobCompletedCallback?: (error: Error | null, result: MailResponse<unknown>) => void = (
     error
@@ -58,7 +58,7 @@ export class MemoryQueueMessenger implements MailerMessenger {
 
   constructor(
     public mailer: MailerContract<MailTransportContract>,
-    emitter: Emitter<MailEvents>
+    emitter: EmitterLike<MailEvents>
   ) {
     this.#emitter = emitter
   }

diff --git a/src/types.ts b/src/types.ts
@@ -8,15 +8,15 @@
  */
 
 import type { TlsOptions } from 'node:tls'
-import { SendMailOptions } from 'nodemailer'
+import type { SendMailOptions } from 'nodemailer'
 import type { SESClientConfig } from '@aws-sdk/client-ses'
 import type { ConfigProvider } from '@adonisjs/core/types'
 import type MimeNode from 'nodemailer/lib/mime-node/index.js'
 
-import { BaseMail } from './base_mail.js'
 import type { Message } from './message.js'
-import { MailManager } from './mail_manager.js'
-import { MailResponse } from './mail_response.js'
+import type { BaseMail } from './base_mail.js'
+import type { MailManager } from './mail_manager.js'
+import type { MailResponse } from './mail_response.js'
 
 /**
  * Shape of the envelope node after the email has been