aedes 0.48.1 → 0.50.0

package/.github/workflows/ci.yml

@@ -32,8 +32,9 @@ jobs:
       contents: read
     strategy:
       matrix:
-        node-version: [14, 16, '*']
+        node-version: [16, 18, 20]
         os: [ubuntu-latest, windows-latest, macOS-latest]
+      fail-fast: false
     steps:
       - uses: actions/checkout@v3
         with:

package/README.md

@@ -281,6 +281,12 @@ Here is a list of some interesting projects that are using Aedes as MQTT Broker.
 Want to contribute? Check our list of
 [features/bugs](https://github.com/moscajs/aedes/projects/1)
 
+## Security notice
+
+Messages sent to the broker are considered _valid_ once they pass the [`authorizePublish`](https://github.com/moscajs/aedes/blob/main/docs/Aedes.md#handler-authorizepublish-client-packet-callback) callback.
+In other terms, if permissions for the given client are revoked after the call completes, the message is still considered valid.
+In case you are sending time-sensitive messages, make sure to use QoS 0 or connect with a clean session.
+
 ## Support
 
 If there are bugs/leaks in production scenarios, we encourage people to send Pull Request and/or reach out maintainers for some paid support.

package/aedes.d.ts

@@ -1,3 +1,12 @@
-/// <reference path="./types/instance.d.ts" />
-/// <reference path="./types/client.d.ts" />
-/// <reference path="./types/packet.d.ts" />
+import Aedes, { AedesOptions } from './types/instance'
+
+export declare function createBroker (options?: AedesOptions): Aedes
+
+export * from './types/instance'
+export * from './types/packet'
+export * from './types/client'
+export default Aedes
+
+declare module 'aedes' {
+  export = Aedes
+}

package/aedes.js

@@ -13,7 +13,7 @@ const mqemitter = require('mqemitter')
 const Client = require('./lib/client')
 const { $SYS_PREFIX, bulk } = require('./lib/utils')
 
-module.exports = Aedes.Server = Aedes
+module.exports = Aedes.createBroker = Aedes
 
 const defaultOptions = {
   concurrency: 100,

package/docs/Examples.md

@@ -13,6 +13,22 @@ server.listen(port, function () {
 })
 ```
 
+## Typescript
+
+```ts
+import Aedes from 'aedes'
+import { createServer } from 'net'
+
+const port = 1883
+
+const aedes = new Aedes()
+const server = createServer(aedes.handle)
+
+server.listen(port, function () {
+  console.log('server started and listening on port ', port)
+})
+```
+
 ## Simple plain MQTT server using server-factory
 
 ```js

package/examples/clusters/index.js

@@ -1,34 +1,46 @@
 const cluster = require('cluster')
-const mqemitter = require('mqemitter-mongodb')
-const mongoPersistence = require('aedes-persistence-mongodb')
-
+const Aedes = require('aedes')
+const { createServer } = require('net')
+const { cpus } = require('os')
 const MONGO_URL = 'mongodb://127.0.0.1/aedes-clusters'
 
+const mq = process.env.MQ === 'redis'
+  ? require('mqemitter-redis')({
+    port: process.env.REDIS_PORT || 6379
+  })
+  : require('mqemitter-mongodb')({
+    url: MONGO_URL
+  })
+
+const persistence = process.env.PERSISTENCE === 'redis'
+  ? require('aedes-persistence-redis')({
+    port: process.env.REDIS_PORT || 6379
+  })
+  : require('aedes-persistence-mongodb')({
+    url: MONGO_URL
+  })
+
 function startAedes () {
   const port = 1883
 
-  const aedes = require('aedes')({
+  const aedes = Aedes({
     id: 'BROKER_' + cluster.worker.id,
-    mq: mqemitter({
-      url: MONGO_URL
-    }),
-    persistence: mongoPersistence({
-      url: MONGO_URL,
-      // Optional ttl settings
-      ttl: {
-        packets: 300, // Number of seconds
-        subscriptions: 300
-      }
-    })
+    mq,
+    persistence
   })
 
-  const server = require('net').createServer(aedes.handle)
+  const server = createServer(aedes.handle)
 
-  server.listen(port, function () {
+  server.listen(port, '0.0.0.0', function () {
     console.log('Aedes listening on port:', port)
     aedes.publish({ topic: 'aedes/hello', payload: "I'm broker " + aedes.id })
   })
 
+  server.on('error', function (err) {
+    console.log('Server error', err)
+    process.exit(1)
+  })
+
   aedes.on('subscribe', function (subscriptions, client) {
     console.log('MQTT client \x1b[32m' + (client ? client.id : client) +
             '\x1b[0m subscribed to topics: ' + subscriptions.map(s => s.topic).join('\n'), 'from broker', aedes.id)
@@ -56,7 +68,7 @@ function startAedes () {
 }
 
 if (cluster.isMaster) {
-  const numWorkers = require('os').cpus().length
+  const numWorkers = cpus().length
   for (let i = 0; i < numWorkers; i++) {
     cluster.fork()
   }

package/examples/clusters/package.json

@@ -9,8 +9,10 @@
   "author": "robertsLando",
   "license": "MIT",
   "dependencies": {
-    "aedes": "^0.45.0",
-    "aedes-persistence-mongodb": "^7.0.1",
-    "mqemitter-mongodb": "^7.0.1"
+    "aedes": "^0.48.1",
+    "aedes-persistence-mongodb": "^9.1.0",
+    "aedes-persistence-redis": "^9.0.1",
+    "mqemitter-mongodb": "^8.1.0",
+    "mqemitter-redis": "^5.0.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aedes",
-  "version": "0.48.1",
+  "version": "0.50.0",
   "description": "Stream-based MQTT broker",
   "main": "aedes.js",
   "types": "aedes.d.ts",
@@ -94,27 +94,27 @@
   },
   "homepage": "https://github.com/moscajs/aedes#readme",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "devDependencies": {
-    "@sinonjs/fake-timers": "^9.1.2",
-    "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
+    "@sinonjs/fake-timers": "^10.3.0",
+    "@types/node": "^20.4.5",
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@typescript-eslint/parser": "^6.2.0",
     "concat-stream": "^2.0.0",
     "duplexify": "^4.1.2",
     "license-checker": "^25.0.1",
-    "markdownlint-cli": "^0.32.1",
-    "mqtt": "^4.3.7",
+    "markdownlint-cli": "^0.35.0",
+    "mqtt": "^5.0.0",
     "mqtt-connection": "^4.1.0",
     "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
-    "release-it": "^15.2.0",
+    "release-it": "^16.1.3",
     "snazzy": "^9.0.0",
-    "standard": "^17.0.0",
-    "tap": "^16.3.0",
-    "tsd": "^0.24.0",
-    "typescript": "^4.7.4",
+    "standard": "^17.1.0",
+    "tap": "^16.3.7",
+    "tsd": "^0.28.1",
+    "typescript": "^5.1.6",
     "websocket-stream": "^5.5.2"
   },
   "dependencies": {
@@ -124,9 +124,9 @@
     "fastfall": "^1.5.1",
     "fastparallel": "^2.4.1",
     "fastseries": "^2.0.0",
-    "hyperid": "^3.0.1",
+    "hyperid": "^3.1.1",
     "mqemitter": "^5.0.0",
-    "mqtt-packet": "^8.1.1",
+    "mqtt-packet": "^8.2.0",
     "retimer": "^3.0.0",
     "reusify": "^1.0.4",
     "uuid": "^9.0.0"

package/test/basic.js

@@ -6,10 +6,10 @@ const { setup, connect, subscribe, subscribeMultiple, noError } = require('./hel
 const aedes = require('../')
 const proxyquire = require('proxyquire')
 
-test('test aedes.Server', function (t) {
+test('test aedes.createBroker', function (t) {
   t.plan(1)
 
-  const broker = new aedes.Server()
+  const broker = aedes.createBroker()
   t.teardown(broker.close.bind(broker))
 
   connect(setup(broker), {}, function () {

package/test/types/aedes.test-d.ts

@@ -1,16 +1,17 @@
-/// <reference path="../../aedes.d.ts" />
-
-import type { AedesPublishPacket, ConnackPacket, ConnectPacket, PingreqPacket, PublishPacket, PubrelPacket, SubscribePacket, Subscription, UnsubscribePacket } from 'aedes:packet'
-import type { AuthenticateError, Brokers, Connection } from 'aedes:server'
-import Server, { Aedes } from 'aedes:server'
-
 import { IncomingMessage } from 'node:http'
-import type { Client } from 'aedes:client'
 import { Socket } from 'node:net'
+import type {
+  Brokers,
+  AuthenticateError,
+  Client,
+  Connection
+} from '../../aedes'
+import Aedes, { createBroker } from '../../aedes'
+import type { AedesPublishPacket, ConnackPacket, ConnectPacket, PingreqPacket, PublishPacket, PubrelPacket, Subscription, SubscribePacket, UnsubscribePacket } from '../../types/packet'
 import { expectType } from 'tsd'
 
 // Aedes server
-let broker = new Server()
+let broker = createBroker()
 expectType<Aedes>(broker)
 
 broker = new Aedes({
@@ -29,8 +30,17 @@ broker = new Aedes({
       callback(new Error('connection error'), false)
     }
   },
-  authenticate: (client: Client, username: Readonly<string>, password: Readonly<Buffer>, callback) => {
-    if (username === 'test' && password === Buffer.from('test') && client.version === 4) {
+  authenticate: (
+    client: Client,
+    username: Readonly<string | undefined>,
+    password: Readonly<Buffer | undefined>,
+    callback
+  ) => {
+    if (
+      username === 'test' &&
+      password === Buffer.from('test') &&
+      client.version === 4
+    ) {
       callback(null, true)
     } else {
       const error = new Error() as AuthenticateError
@@ -39,7 +49,11 @@ broker = new Aedes({
       callback(error, false)
     }
   },
-  authorizePublish: (client: Client | null, packet: PublishPacket, callback) => {
+  authorizePublish: (
+    client: Client | null,
+    packet: PublishPacket,
+    callback
+  ) => {
     if (packet.topic === 'aaaa') {
       return callback(new Error('wrong topic'))
     }
@@ -66,7 +80,10 @@ broker = new Aedes({
     if (packet.topic === 'aaaa' && client.id === 'I should not see this') {
       return null
       // also works with return undefined
-    } else if (packet.topic === 'aaaa' && client.id === 'I should not see this either') {
+    } else if (
+      packet.topic === 'aaaa' &&
+      client.id === 'I should not see this either'
+    ) {
       return
     }
 
@@ -91,75 +108,107 @@ expectType<Aedes>(broker.on('client', (client: Client) => {}))
 expectType<Aedes>(broker.on('clientReady', (client: Client) => {}))
 expectType<Aedes>(broker.on('clientDisconnect', (client: Client) => {}))
 expectType<Aedes>(broker.on('keepaliveTimeout', (client: Client) => {}))
-expectType<Aedes>(broker.on('clientError', (client: Client, error: Error) => {}))
-expectType<Aedes>(broker.on('connectionError', (client: Client, error: Error) => {}))
-expectType<Aedes>(broker.on('connackSent', (packet: ConnackPacket, client: Client) => {}))
-expectType<Aedes>(broker.on('ping', (packet: PingreqPacket, client: Client) => {}))
-expectType<Aedes>(broker.on('publish', (packet: AedesPublishPacket, client: Client | null) => {}))
-expectType<Aedes>(broker.on('ack', (packet: PublishPacket | PubrelPacket, client: Client) => {}))
-expectType<Aedes>(broker.on('subscribe', (subscriptions: Subscription[], client: Client) => {}))
-expectType<Aedes>(broker.on('unsubscribe', (unsubscriptions: string[], client: Client) => {}))
-
-expectType<void>(broker.publish(
-  {} as PublishPacket,
-  (error?: Error) => {
+expectType<Aedes>(
+  broker.on('clientError', (client: Client, error: Error) => {})
+)
+expectType<Aedes>(
+  broker.on('connectionError', (client: Client, error: Error) => {})
+)
+expectType<Aedes>(
+  broker.on('connackSent', (packet: ConnackPacket, client: Client) => {})
+)
+expectType<Aedes>(
+  broker.on('ping', (packet: PingreqPacket, client: Client) => {})
+)
+expectType<Aedes>(
+  broker.on(
+    'publish',
+    (packet: AedesPublishPacket, client: Client | null) => {}
+  )
+)
+expectType<Aedes>(
+  broker.on('ack', (packet: PublishPacket | PubrelPacket, client: Client) => {})
+)
+expectType<Aedes>(
+  broker.on('subscribe', (subscriptions: Subscription[], client: Client) => {})
+)
+expectType<Aedes>(
+  broker.on('unsubscribe', (unsubscriptions: string[], client: Client) => {})
+)
+
+expectType<void>(
+  broker.publish({} as PublishPacket, (error?: Error) => {
     if (error) {
       console.error(error)
     }
-  }
-))
-
-expectType<void>(broker.subscribe(
-  'topic',
-  (packet: AedesPublishPacket, callback: () => void) => {},
-  () => {}
-))
-
-expectType<void>(broker.unsubscribe(
-  'topic',
-  (packet: AedesPublishPacket, callback: () => void) => {},
-  () => {}
-))
+  })
+)
+
+expectType<void>(
+  broker.subscribe(
+    'topic',
+    (packet: AedesPublishPacket, callback: () => void) => {},
+    () => {}
+  )
+)
+
+expectType<void>(
+  broker.unsubscribe(
+    'topic',
+    (packet: AedesPublishPacket, callback: () => void) => {},
+    () => {}
+  )
+)
 
 expectType<void>(broker.close())
 expectType<void>(broker.close(() => {}))
 
 // Aedes client
 const client = broker.handle({} as Connection, {} as IncomingMessage)
+const client2 = broker.handle({} as Connection)
 
 expectType<Client>(client)
+expectType<Client>(client2)
 
 expectType<Connection>(client.conn)
 expectType<IncomingMessage>(client.req!)
 
 expectType<Client>(client.on('connected', () => {}))
-expectType<Client>(client.on('error', (error: Error) => {
-  if (error) {
-    console.error(error)
-  }
-}))
+expectType<Client>(
+  client.on('error', (error: Error) => {
+    if (error) {
+      console.error(error)
+    }
+  })
+)
 
-expectType<void>(client.publish({} as PublishPacket, (error?: Error) => {
-  if (error) {
-    console.error(error)
-  }
-}))
+expectType<void>(
+  client.publish({} as PublishPacket, (error?: Error) => {
+    if (error) {
+      console.error(error)
+    }
+  })
+)
 expectType<void>(client.publish({} as PublishPacket))
 
-expectType<void>(client.subscribe({} as Subscription, (error?: Error) => {
-  if (error) {
-    console.error(error)
-  }
-}))
+expectType<void>(
+  client.subscribe({} as Subscription, (error?: Error) => {
+    if (error) {
+      console.error(error)
+    }
+  })
+)
 expectType<void>(client.subscribe({} as Subscription))
 expectType<void>(client.subscribe([] as Subscription[]))
 expectType<void>(client.subscribe({} as SubscribePacket))
 
-expectType<void>(client.unsubscribe({} as Subscription, (error?: Error) => {
-  if (error) {
-    console.error(error)
-  }
-}))
+expectType<void>(
+  client.unsubscribe({} as Subscription, (error?: Error) => {
+    if (error) {
+      console.error(error)
+    }
+  })
+)
 expectType<void>(client.unsubscribe({} as Subscription))
 expectType<void>(client.unsubscribe([] as Subscription[]))
 expectType<void>(client.unsubscribe({} as UnsubscribePacket))

package/types/client.d.ts

@@ -1,32 +1,44 @@
-declare module 'client' {
-  import { IncomingMessage } from 'node:http'
-  import { PublishPacket, SubscribePacket, Subscription, Subscriptions, UnsubscribePacket } from 'aedes:packet'
-  import { Connection } from 'aedes:server'
-  import { EventEmitter } from 'node:events'
+import { IncomingMessage } from 'node:http'
+import {
+  PublishPacket,
+  SubscribePacket,
+  Subscription,
+  Subscriptions,
+  UnsubscribePacket
+} from './packet'
+import { Connection } from './instance'
+import { EventEmitter } from 'node:events'
 
-  export interface Client extends EventEmitter {
-    id: Readonly<string>
-    clean: Readonly<boolean>
-    version: Readonly<number>
-    conn: Connection
-    req?: IncomingMessage
-    connecting: Readonly<boolean>
-    connected: Readonly<boolean>
-    closed: Readonly<boolean>
+export interface Client extends EventEmitter {
+  id: Readonly<string>;
+  clean: Readonly<boolean>;
+  version: Readonly<number>;
+  conn: Connection;
+  req?: IncomingMessage;
+  connecting: Readonly<boolean>;
+  connected: Readonly<boolean>;
+  closed: Readonly<boolean>;
 
-    on (event: 'connected', listener: () => void): this
-    on (event: 'error', listener: (error: Error) => void): this
+  on(event: 'connected', listener: () => void): this;
+  on(event: 'error', listener: (error: Error) => void): this;
 
-    publish (message: PublishPacket, callback?: (error?: Error) => void): void
-    subscribe (
-      subscriptions: Subscriptions | Subscription | Subscription[] | SubscribePacket,
-      callback?: (error?: Error) => void
-    ): void
-    unsubscribe (topicObjects: Subscriptions | Subscription | Subscription[] | UnsubscribePacket, callback?: (error?: Error) => void): void
-    close (callback?: () => void): void
-    emptyOutgoingQueue (callback?: () => void): void
-  }
-}
-declare module 'aedes:client' {
-  export * from 'client'
+  publish(message: PublishPacket, callback?: (error?: Error) => void): void;
+  subscribe(
+    subscriptions:
+    | Subscriptions
+    | Subscription
+    | Subscription[]
+    | SubscribePacket,
+    callback?: (error?: Error) => void
+  ): void;
+  unsubscribe(
+    topicObjects:
+    | Subscriptions
+    | Subscription
+    | Subscription[]
+    | UnsubscribePacket,
+    callback?: (error?: Error) => void
+  ): void;
+  close(callback?: () => void): void;
+  emptyOutgoingQueue(callback?: () => void): void;
 }

package/types/instance.d.ts

@@ -1,101 +1,159 @@
-declare module 'aedes' {
-  import { Duplex } from 'node:stream'
-  import { Socket } from 'node:net'
-  import { IncomingMessage } from 'http'
-  import { Client } from 'aedes:client'
-  import type { AedesPublishPacket, ConnectPacket, ConnackPacket, Subscription, PingreqPacket, PublishPacket, PubrelPacket } from 'aedes:packet'
-  import { EventEmitter } from 'node:events'
-
-  type LastHearthbeatTimestamp = Date;
-
-  export interface Brokers {
-    [brokerId: string]: LastHearthbeatTimestamp;
-  }
-
-  export type Connection = Duplex | Socket
-
-  /* eslint no-unused-vars: 0 */
-  export const enum AuthErrorCode {
-    UNNACCEPTABLE_PROTOCOL = 1,
-    IDENTIFIER_REJECTED = 2,
-    SERVER_UNAVAILABLE = 3,
-    BAD_USERNAME_OR_PASSWORD = 4,
-    NOT_AUTHORIZED = 5
-  }
-
-  export type AuthenticateError = Error & { returnCode: AuthErrorCode }
-
-  type PreConnectHandler = (client: Client, packet: ConnectPacket, callback: (error: Error | null, success: boolean) => void) => void
-
-  type AuthenticateHandler = (
-    client: Client,
-    username: Readonly<string>,
-    password: Readonly<Buffer>,
-    done: (error: AuthenticateError | null, success: boolean | null) => void
-  ) => void
-
-  type AuthorizePublishHandler = (client: Client | null, packet: PublishPacket, callback: (error?: Error | null) => void) => void
-
-  type AuthorizeSubscribeHandler = (client: Client, subscription: Subscription, callback: (error: Error | null, subscription?: Subscription | null) => void) => void
-
-  type AuthorizeForwardHandler = (client: Client, packet: AedesPublishPacket) => AedesPublishPacket | null | void
-
-  type PublishedHandler = (packet: AedesPublishPacket, client: Client, callback: (error?: Error | null) => void) => void
-
-  export interface AedesOptions {
-    mq?: any
-    id?: string
-    persistence?: any
-    concurrency?: number
-    heartbeatInterval?: number
-    connectTimeout?: number
-    queueLimit?: number
-    maxClientsIdLength?: number
-    preConnect?: PreConnectHandler
-    authenticate?: AuthenticateHandler
-    authorizePublish?: AuthorizePublishHandler
-    authorizeSubscribe?: AuthorizeSubscribeHandler
-    authorizeForward?: AuthorizeForwardHandler
-    published?: PublishedHandler
-  }
-
-  export default class Aedes extends EventEmitter {
-    id: Readonly<string>
-    connectedClients: Readonly<number>
-    closed: Readonly<boolean>
-    brokers: Readonly<Brokers>
-
-    constructor(option?: AedesOptions)
-    handle: (stream: Connection, request: IncomingMessage) => Client
-
-    on (event: 'closed', listener: () => void): this
-    on (event: 'client' | 'clientReady' | 'clientDisconnect' | 'keepaliveTimeout', listener: (client: Client) => void): this
-    on (event: 'clientError' | 'connectionError', listener: (client: Client, error: Error) => void): this
-    on (event: 'connackSent', listener: (packet: ConnackPacket, client: Client) => void): this
-    on (event: 'ping', listener: (packet: PingreqPacket, client: Client) => void): this
-    on (event: 'publish', listener: (packet: AedesPublishPacket, client: Client | null) => void): this
-    on (event: 'ack', listener: (packet: PublishPacket | PubrelPacket, client: Client) => void): this
-    on (event: 'subscribe', listener: (subscriptions: Subscription[], client: Client) => void): this
-    on (event: 'unsubscribe', listener: (unsubscriptions: string[], client: Client) => void): this
-
-    publish (packet: PublishPacket, callback: (error?: Error) => void): void
-    subscribe (topic: string, deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void, callback: () => void): void
-    unsubscribe (topic: string, deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void, callback: () => void): void
-    close (callback?: () => void): void
-
-    preConnect: PreConnectHandler
-    authenticate: AuthenticateHandler
-    authorizePublish: AuthorizePublishHandler
-    authorizeSubscribe: AuthorizeSubscribeHandler
-    authorizeForward: AuthorizeForwardHandler
-    published: PublishedHandler
-  }
-
-  export { Aedes }
-  // export function createServer(options?: AedesOptions): Aedes
+import { Duplex } from 'node:stream'
+import { Socket } from 'node:net'
+import { IncomingMessage } from 'http'
+import { Client } from './client'
+import type {
+  AedesPublishPacket,
+  ConnectPacket,
+  ConnackPacket,
+  Subscription,
+  PingreqPacket,
+  PublishPacket,
+  PubrelPacket
+} from './packet'
+import { EventEmitter } from 'node:events'
+
+type LastHearthbeatTimestamp = Date;
+
+export interface Brokers {
+  [brokerId: string]: LastHearthbeatTimestamp;
 }
 
-declare module 'aedes:server' {
-  export * from 'aedes'
-  export { default } from 'aedes'
+export type Connection = Duplex | Socket;
+
+/* eslint no-unused-vars: 0 */
+export const enum AuthErrorCode {
+  UNNACCEPTABLE_PROTOCOL = 1,
+  IDENTIFIER_REJECTED = 2,
+  SERVER_UNAVAILABLE = 3,
+  BAD_USERNAME_OR_PASSWORD = 4,
+  NOT_AUTHORIZED = 5,
+}
+
+export type AuthenticateError = Error & { returnCode: AuthErrorCode };
+
+type PreConnectHandler = (
+  client: Client,
+  packet: ConnectPacket,
+  callback: (error: Error | null, success: boolean) => void
+) => void;
+
+type AuthenticateHandler = (
+  client: Client,
+  username: Readonly<string | undefined>,
+  password: Readonly<Buffer | undefined>,
+  done: (error: AuthenticateError | null, success: boolean | null) => void
+) => void;
+
+type AuthorizePublishHandler = (
+  client: Client | null,
+  packet: PublishPacket,
+  callback: (error?: Error | null) => void
+) => void;
+
+type AuthorizeSubscribeHandler = (
+  client: Client,
+  subscription: Subscription,
+  callback: (error: Error | null, subscription?: Subscription | null) => void
+) => void;
+
+type AuthorizeForwardHandler = (
+  client: Client,
+  packet: AedesPublishPacket
+) => AedesPublishPacket | null | void;
+
+type PublishedHandler = (
+  packet: AedesPublishPacket,
+  client: Client,
+  callback: (error?: Error | null) => void
+) => void;
+
+export interface AedesOptions {
+  mq?: any;
+  id?: string;
+  persistence?: any;
+  concurrency?: number;
+  heartbeatInterval?: number;
+  connectTimeout?: number;
+  queueLimit?: number;
+  maxClientsIdLength?: number;
+  preConnect?: PreConnectHandler;
+  authenticate?: AuthenticateHandler;
+  authorizePublish?: AuthorizePublishHandler;
+  authorizeSubscribe?: AuthorizeSubscribeHandler;
+  authorizeForward?: AuthorizeForwardHandler;
+  published?: PublishedHandler;
+}
+
+export default class Aedes extends EventEmitter {
+  id: Readonly<string>
+  connectedClients: Readonly<number>
+  closed: Readonly<boolean>
+  brokers: Readonly<Brokers>
+
+  constructor(option?: AedesOptions);
+  handle: (stream: Connection, request?: IncomingMessage) => Client
+
+  on(event: 'closed', listener: () => void): this;
+  on(
+    event: 'client' | 'clientReady' | 'clientDisconnect' | 'keepaliveTimeout',
+    listener: (client: Client) => void
+  ): this;
+
+  on(
+    event: 'clientError' | 'connectionError',
+    listener: (client: Client, error: Error) => void
+  ): this;
+
+  on(
+    event: 'connackSent',
+    listener: (packet: ConnackPacket, client: Client) => void
+  ): this;
+
+  on(
+    event: 'ping',
+    listener: (packet: PingreqPacket, client: Client) => void
+  ): this;
+
+  on(
+    event: 'publish',
+    listener: (packet: AedesPublishPacket, client: Client | null) => void
+  ): this;
+
+  on(
+    event: 'ack',
+    listener: (packet: PublishPacket | PubrelPacket, client: Client) => void
+  ): this;
+
+  on(
+    event: 'subscribe',
+    listener: (subscriptions: Subscription[], client: Client) => void
+  ): this;
+
+  on(
+    event: 'unsubscribe',
+    listener: (unsubscriptions: string[], client: Client) => void
+  ): this;
+
+  publish(packet: PublishPacket, callback: (error?: Error) => void): void;
+  subscribe(
+    topic: string,
+    deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void,
+    callback: () => void
+  ): void;
+
+  unsubscribe(
+    topic: string,
+    deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void,
+    callback: () => void
+  ): void;
+
+  close(callback?: () => void): void;
+
+  preConnect: PreConnectHandler
+  authenticate: AuthenticateHandler
+  authorizePublish: AuthorizePublishHandler
+  authorizeSubscribe: AuthorizeSubscribeHandler
+  authorizeForward: AuthorizeForwardHandler
+  published: PublishedHandler
 }

package/types/packet.d.ts

@@ -1,23 +1,27 @@
-declare module 'packet' {
-  import { AedesPacket } from 'aedes-packet'
-  import { IConnackPacket, IConnectPacket, IPingreqPacket, IPublishPacket, IPubrelPacket, ISubscribePacket, ISubscription, IUnsubscribePacket } from 'mqtt-packet'
-  import { Client } from 'aedes:client'
+import { AedesPacket } from 'aedes-packet'
+import {
+  IConnackPacket,
+  IConnectPacket,
+  IPingreqPacket,
+  IPublishPacket,
+  IPubrelPacket,
+  ISubscribePacket,
+  ISubscription,
+  IUnsubscribePacket
+} from 'mqtt-packet'
+import { Client } from './client'
 
-  export type SubscribePacket = ISubscribePacket & { cmd: 'subscribe' }
-  export type UnsubscribePacket = IUnsubscribePacket & { cmd: 'unsubscribe' }
-  export type Subscription = ISubscription & { clientId?: Client['id'] }
-  export type Subscriptions = { subscriptions: Subscription[] }
+export type SubscribePacket = ISubscribePacket & { cmd: 'subscribe' };
+export type UnsubscribePacket = IUnsubscribePacket & { cmd: 'unsubscribe' };
+export type Subscription = ISubscription & { clientId?: Client['id'] };
+export type Subscriptions = { subscriptions: Subscription[] };
 
-  export type PublishPacket = IPublishPacket & { cmd: 'publish' }
+export type PublishPacket = IPublishPacket & { cmd: 'publish' };
 
-  export type ConnectPacket = IConnectPacket & { cmd: 'connect' }
-  export type ConnackPacket = IConnackPacket & { cmd: 'connack' }
+export type ConnectPacket = IConnectPacket & { cmd: 'connect' };
+export type ConnackPacket = IConnackPacket & { cmd: 'connack' };
 
-  export type PubrelPacket = IPubrelPacket & { cmd: 'pubrel' }
-  export type PingreqPacket = IPingreqPacket & { cmd: 'pingreq' }
+export type PubrelPacket = IPubrelPacket & { cmd: 'pubrel' };
+export type PingreqPacket = IPingreqPacket & { cmd: 'pingreq' };
 
-  export type AedesPublishPacket = PublishPacket & AedesPacket
-}
-declare module 'aedes:packet' {
-  export * from 'packet'
-}
+export type AedesPublishPacket = PublishPacket & AedesPacket;

package/types/tsconfig.json

@@ -5,11 +5,11 @@
     "noEmit": true,
     "strict": true,
     "removeComments": true,
-    "typeRoots" : ["../types", "../node_modules/@types/"]
+    "typeRoots" : ["./", "../node_modules/@types/"]
   },
   "include": [
-    "./test/types/*.test-d.ts",
-    "./types/*.d.ts",
-    "aedes.d.ts"
+    "../test/types/*.test-d.ts",
+    "./*.d.ts",
+    "../aedes.d.ts"
   ]
 }