Improve Typescript typings to allow explicit typing (moscajs#206)

* Improve Typescript typings to allow explicit typing * Add Server alias property to aedes function
mvandevalk · Apr 23, 2019 · 36ec8b6 · 36ec8b6
1 parent 9dbdc56
commit 36ec8b6
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 96 deletions.
diff --git a/aedes.js b/aedes.js
@@ -14,6 +14,7 @@ var reusify = require('reusify')
 var Client = require('./lib/client')
 
 module.exports = Aedes
+Aedes.Server = Aedes
 
 var defaultOptions = {
   concurrency: 100,

diff --git a/test/typescript/typings.ts b/test/typescript/typings.ts
@@ -1,24 +1,24 @@
 // relative path uses package.json {"types":"types/index.d.ts", ...}
 
-import Aedes = require ('../..')
+import { Server, Client, AuthenticateError } from '../..'
 import { IPublishPacket, ISubscribePacket, ISubscription, IUnsubscribePacket } from 'mqtt-packet'
 import { createServer } from 'net'
 
-const aedes = Aedes({
+const broker = Server({
   concurrency: 100,
   heartbeatInterval: 60000,
   connectTimeout: 30000,
-  authenticate: (client, username: string, password: string, callback) => {
+  authenticate: (client: Client, username: string, password: string, callback) => {
     if (username === 'test' && password === 'test') {
       callback(null, true)
     } else {
-      const error = new Error() as Error & { returnCode: number }
+      const error = new Error() as AuthenticateError
       error.returnCode = 1
 
       callback(error, false)
     }
   },
-  authorizePublish: (client, packet: IPublishPacket, callback) => {
+  authorizePublish: (client: Client, packet: IPublishPacket, callback) => {
     if (packet.topic === 'aaaa') {
       return callback(new Error('wrong topic'))
     }
@@ -29,7 +29,7 @@ const aedes = Aedes({
 
     callback(null)
   },
-  authorizeSubscribe: (client, sub: ISubscription, callback) => {
+  authorizeSubscribe: (client: Client, sub: ISubscription, callback) => {
     if (sub.topic === 'aaaa') {
       return callback(new Error('wrong topic'))
     }
@@ -57,70 +57,70 @@ const aedes = Aedes({
   }
 })
 
-const server = createServer(aedes.handle)
+const server = createServer(broker.handle)
 
-aedes.on('closed', () => {
+broker.on('closed', () => {
   console.log(`closed`)
 })
 
-aedes.on('client', client => {
+broker.on('client', client => {
   console.log(`client: ${client.id} connected`)
 })
 
-aedes.on('clientDisconnect', client => {
+broker.on('clientDisconnect', client => {
   console.log(`client: ${client.id} disconnected`)
 })
 
-aedes.on('keepaliveTimeout', client => {
+broker.on('keepaliveTimeout', client => {
   console.log(`client: ${client.id} timed out`)
 })
 
-aedes.on('connackSent', client => {
+broker.on('connackSent', client => {
   console.log(`client: ${client.id} connack sent`)
 })
 
-aedes.on('clientError', client => {
+broker.on('clientError', client => {
   console.log(`client: ${client.id} error`)
 })
 
-aedes.on('connectionError', client => {
+broker.on('connectionError', client => {
   console.log('connectionError')
 })
 
-aedes.on('ping', (packet, client) => {
+broker.on('ping', (packet, client) => {
   console.log(`client: ${client.id} ping with packet ${packet.id}`)
 })
 
-aedes.on('publish', (packet, client) => {
+broker.on('publish', (packet, client) => {
   console.log(`client: ${client.id} published packet ${packet.id}`)
 })
 
-aedes.on('ack', (packet, client) => {
+broker.on('ack', (packet, client) => {
   console.log(`client: ${client.id} ack with packet ${packet.id}`)
 })
 
-aedes.on('subscribe', (subscriptions, client) => {
+broker.on('subscribe', (subscriptions, client) => {
   console.log(`client: ${client.id} subsribe`)
 })
 
-aedes.on('unsubscribe', (subscriptions, client) => {
+broker.on('unsubscribe', (subscriptions, client) => {
   console.log(`client: ${client.id} subsribe`)
 })
 
-aedes.subscribe('aaaa', (packet: ISubscribePacket, cb) => {
+broker.subscribe('aaaa', (packet: ISubscribePacket, cb) => {
   console.log('cmd')
   console.log(packet.subscriptions)
   cb()
 }, () => {
   console.log('done subscribing')
 })
 
-aedes.unsubscribe('aaaa', (packet: IUnsubscribePacket, cb) => {
+broker.unsubscribe('aaaa', (packet: IUnsubscribePacket, cb) => {
   console.log('cmd')
   console.log(packet.unsubscriptions)
   cb()
 }, () => {
   console.log('done unsubscribing')
 })
 
-aedes.close()
+broker.close()
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -4,81 +4,87 @@ import { IPublishPacket, ISubscribePacket, ISubscription, IUnsubscribePacket } f
 import { Duplex } from 'stream'
 import EventEmitter = NodeJS.EventEmitter
 
-declare enum AuthErrorCode {
-  UNNACCEPTABLE_PROTOCOL = 1,
-  IDENTIFIER_REJECTED = 2,
-  SERVER_UNAVAILABLE = 3,
-  BAD_USERNAME_OR_PASSWORD = 4
+declare namespace aedes {
+  export enum AuthErrorCode {
+    UNNACCEPTABLE_PROTOCOL = 1,
+    IDENTIFIER_REJECTED = 2,
+    SERVER_UNAVAILABLE = 3,
+    BAD_USERNAME_OR_PASSWORD = 4
+  }
+
+  export interface Client extends EventEmitter {
+    id: string
+    clean: boolean
+
+    on (event: 'error', cb: (err: Error) => void): this
+
+    publish (message: IPublishPacket, callback?: () => void): void
+    subscribe (
+      subscriptions: ISubscription | ISubscription[] | ISubscribePacket,
+      callback?: () => void
+    ): void
+    unsubscribe (topicObjects: ISubscription | ISubscription[], callback?: () => void): void
+    close (callback?: () => void): void
+  }
+
+  export type AuthenticateError = Error & { returnCode: AuthErrorCode }
+
+  export type AuthenticateCallback = (
+    client: Client,
+    username: string,
+    password: string,
+    done: (err: AuthenticateError | null, success: boolean | null) => void
+  ) => void
+
+  export type AuthorizePublishCallback = (client: Client, packet: IPublishPacket, done: (err?: Error | null) => void) => void
+
+  export type AuthorizeSubscribeCallback = (client: Client, subscription: ISubscription, done: (err: Error | null, subscription?: ISubscription | null) => void) => void
+
+  export type AuthorizeForwardCallback = (client: Client, packet: IPublishPacket) => IPublishPacket | null | void
+
+  export type PublishedCallback = (packet: IPublishPacket, client: Client, done: () => void) => void
+
+  export interface AedesOptions {
+    mq?: any
+    persistence?: any
+    concurrency?: number
+    heartbeatInterval?: number
+    connectTimeout?: number
+    authenticate?: AuthenticateCallback
+    authorizePublish?: AuthorizePublishCallback
+    authorizeSubscribe?: AuthorizeSubscribeCallback
+    authorizeForward?: AuthorizeForwardCallback
+    published?: PublishedCallback
+  }
+
+  export interface Aedes extends EventEmitter {
+    handle: (stream: Duplex) => void
+
+    authenticate: AuthenticateCallback
+    authorizePublish: AuthorizePublishCallback
+    authorizeSubscribe: AuthorizeSubscribeCallback
+    authorizeForward: AuthorizeForwardCallback
+    published: PublishedCallback
+
+    on (event: 'closed', cb: () => void): this
+    on (event: 'client' | 'clientDisconnect' | 'keepaliveTimeout' | 'connackSent', cb: (client: Client) => void): this
+    on (event: 'clientError' | 'connectionError', cb: (client: Client, error: Error) => void): this
+    on (event: 'ping' | 'publish' | 'ack', cb: (packet: any, client: Client) => void): this
+    on (event: 'subscribe' | 'unsubscribe', cb: (subscriptions: ISubscription | ISubscription[] | ISubscribePacket, client: Client) => void): this
+
+    publish (packet: IPublishPacket & { topic: string | Buffer }, done: () => void): void
+    subscribe (topic: string, callback: (packet: ISubscribePacket, cb: () => void) => void, done: () => void): void
+    unsubscribe (
+      topic: string,
+      callback: (packet: IUnsubscribePacket, cb: () => void) => void,
+      done: () => void
+    ): void
+    close (callback?: () => void): void
+  }
+
+  export function Server (options?: aedes.AedesOptions): aedes.Aedes
 }
 
-interface Client extends EventEmitter {
-  id: string
-  clean: boolean
-
-  on (event: 'error', cb: (err: Error) => void): this
-
-  publish (message: IPublishPacket, callback?: () => void): void
-  subscribe (
-    subscriptions: ISubscription | ISubscription[] | ISubscribePacket,
-    callback?: () => void
-  ): void
-  unsubscribe (topicObjects: ISubscription | ISubscription[], callback?: () => void): void
-  close (callback?: () => void): void
-}
-
-type AuthenticateCallback = (
-  client: Client,
-  username: string,
-  password: string,
-  done: (err: Error & { returnCode: AuthErrorCode } | null, success: boolean | null) => void
-) => void
-
-type AuthorizePublishCallback = (client: Client, packet: IPublishPacket, done: (err?: Error | null) => void) => void
-
-type AuthorizeSubscribeCallback = (client: Client, subscription: ISubscription, done: (err: Error | null, subscription?: ISubscription | null) => void) => void
-
-type AuthorizeForwardCallback = (client: Client, packet: IPublishPacket) => IPublishPacket | null | void
-
-type PublishedCallback = (packet: IPublishPacket, client: Client, done: () => void) => void
-
-interface AedesOptions {
-  mq?: any
-  persistence?: any
-  concurrency?: number
-  heartbeatInterval?: number
-  connectTimeout?: number
-  authenticate?: AuthenticateCallback
-  authorizePublish?: AuthorizePublishCallback
-  authorizeSubscribe?: AuthorizeSubscribeCallback
-  authorizeForward?: AuthorizeForwardCallback
-  published?: PublishedCallback
-}
-
-interface Aedes extends EventEmitter {
-  handle: (stream: Duplex) => void
-
-  authenticate: AuthenticateCallback
-  authorizePublish: AuthorizePublishCallback
-  authorizeSubscribe: AuthorizeSubscribeCallback
-  authorizeForward: AuthorizeForwardCallback
-  published: PublishedCallback
-
-  on (event: 'closed', cb: () => void): this
-  on (event: 'client' | 'clientDisconnect' | 'keepaliveTimeout' | 'connackSent', cb: (client: Client) => void): this
-  on (event: 'clientError' | 'connectionError', cb: (client: Client, error: Error) => void): this
-  on (event: 'ping' | 'publish' | 'ack', cb: (packet: any, client: Client) => void): this
-  on (event: 'subscribe' | 'unsubscribe', cb: (subscriptions: ISubscription | ISubscription[] | ISubscribePacket, client: Client) => void): this
-
-  publish (packet: IPublishPacket & { topic: string | Buffer }, done: () => void): void
-  subscribe (topic: string, callback: (packet: ISubscribePacket, cb: () => void) => void, done: () => void): void
-  unsubscribe (
-    topic: string,
-    callback: (packet: IUnsubscribePacket, cb: () => void) => void,
-    done: () => void
-  ): void
-  close (callback?: () => void): void
-}
-
-declare function aedes (options?: AedesOptions): Aedes
+declare function aedes (options?: aedes.AedesOptions): aedes.Aedes
 
 export = aedes