Improved TypeScript declarations for userProperties

bkp7 · bkp7 · commit 746c0bcb7921 · 2021-02-12T10:17:36.000Z
userProperties changed from being object to being {[index: string]: string[]} (name-value string pairs)

Also changed OnConnectCallback and OnMessageCallback to use IConnectPacket and IPublishPacket respectively. These are the specific packets relevant to these callbacks rather than the more generic Packet.

NB Also changed package.json to link to version of mqtt-packet with the equivalent changes which are required. This needs to be updated prior to Pulling.
diff --git a/package.json b/package.json
@@ -68,7 +68,7 @@
     "help-me": "^1.0.1",
     "inherits": "^2.0.3",
     "minimist": "^1.2.5",
-    "mqtt-packet": "^6.6.0",
+    "mqtt-packet": "git://github.com/bkp7/mqtt-packet.git#8647df5315909bb3ac17b6b5635bcd659e172fce",
     "pump": "^3.0.0",
     "readable-stream": "^3.6.0",
     "reinterval": "^1.1.0",
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -23,5 +23,6 @@ export {
   IPingreqPacket,
   IPingrespPacket,
   IDisconnectPacket,
-  Packet
+  Packet,
+  UserProperties
 } from 'mqtt-packet'
diff --git a/types/lib/client-options.d.ts b/types/lib/client-options.d.ts
@@ -1,6 +1,6 @@
 import { MqttClient } from './client'
 import { Store } from './store'
-import { QoS } from 'mqtt-packet'
+import { QoS, UserProperties } from 'mqtt-packet'
 
 export declare type StorePutCallback = () => void
 
@@ -99,7 +99,7 @@ export interface IClientOptions extends ISecureClientOptions {
       contentType?: string,
       responseTopic?: string,
       correlationData?: Buffer,
-      userProperties?: Object
+      userProperties?: UserProperties
     }
   }
   transformWsUrl?: (url: string, options: IClientOptions, client: MqttClient) => string,
@@ -110,7 +110,7 @@ export interface IClientOptions extends ISecureClientOptions {
     topicAliasMaximum?: number,
     requestResponseInformation?: boolean,
     requestProblemInformation?: boolean,
-    userProperties?: Object,
+    userProperties?: UserProperties,
     authenticationMethod?: string,
     authenticationData?: Buffer
   }
@@ -152,7 +152,7 @@ export interface IClientPublishOptions {
     topicAlias?: string,
     responseTopic?: string,
     correlationData?: Buffer,
-    userProperties?: Object,
+    userProperties?: UserProperties,
     subscriptionIdentifier?: number,
     contentType?: string
   }
diff --git a/types/lib/client.d.ts b/types/lib/client.d.ts
@@ -8,7 +8,7 @@ import {
   IClientReconnectOptions
 } from './client-options'
 import { Store } from './store'
-import { Packet, QoS } from 'mqtt-packet'
+import { Packet, IConnectPacket, IPublishPacket, QoS } from 'mqtt-packet'
 
 export interface ISubscriptionGrant {
   /**
@@ -66,9 +66,9 @@ export interface ISubscriptionMap {
   }
 }
 
-export declare type OnConnectCallback = (packet: Packet) => void
+export declare type OnConnectCallback = (packet: IConnectPacket) => void
 export declare type ClientSubscribeCallback = (err: Error, granted: ISubscriptionGrant[]) => void
-export declare type OnMessageCallback = (topic: string, payload: Buffer, packet: Packet) => void
+export declare type OnMessageCallback = (topic: string, payload: Buffer, packet: IPublishPacket) => void
 export declare type OnPacketCallback = (packet: Packet) => void
 export declare type OnErrorCallback = (error: Error) => void
 export declare type PacketCallback = (error?: Error, packet?: Packet) => any
