File Explorer

1/**2 * @packageDocumentation3 * @module mqtt54 */5/**6 * Data model for MQTT5 user properties.7 *8 * A user property is a name-value pair of utf-8 strings that can be added to mqtt5 packets.9 */10export interface UserProperty {11    name: string;12    value: string;13}14/**15 * Server return code for connect attempts.16 *17 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901079) encoding values.18 */19export declare enum ConnectReasonCode {20    /**21     * Returned when the connection is accepted.22     */23    Success = 0,24    /**25     * Returned when the server has a failure but does not want to specify a reason or none26     * of the other reason codes apply.27     */28    UnspecifiedError = 128,29    /**30     * Returned when data in the CONNECT packet could not be correctly parsed by the server.31     */32    MalformedPacket = 129,33    /**34     * Returned when data in the CONNECT packet does not conform to the MQTT5 specification requirements.35     */36    ProtocolError = 130,37    /**38     * Returned when the CONNECT packet is valid but was not accepted by the server.39     */40    ImplementationSpecificError = 131,41    /**42     * Returned when the server does not support MQTT5 protocol version specified in the connection.43     */44    UnsupportedProtocolVersion = 132,45    /**46     * Returned when the client identifier in the CONNECT packet is a valid string but not one that47     * is allowed on the server.48     */49    ClientIdentifierNotValid = 133,50    /**51     * Returned when the server does not accept the username and/or password specified by the client52     * in the connection packet.53     */54    BadUsernameOrPassword = 134,55    /**56     * Returned when the client is not authorized to connect to the server.57     */58    NotAuthorized = 135,59    /**60     * Returned when the MQTT5 server is not available.61     */62    ServerUnavailable = 136,63    /**64     * Returned when the server is too busy to make a connection. It is recommended that the client try again later.65     */66    ServerBusy = 137,67    /**68     * Returned when the client has been banned by the server.69     */70    Banned = 138,71    /**72     * Returned when the authentication method used in the connection is either not supported on the server or it does73     * not match the authentication method currently in use in the CONNECT packet.74     */75    BadAuthenticationMethod = 140,76    /**77     * Returned when the Will topic name sent in the connection packet is correctly formed, but is not accepted by78     * the server.79     */80    TopicNameInvalid = 144,81    /**82     * Returned when the connection packet exceeded the maximum permissible size on the server.83     */84    PacketTooLarge = 149,85    /**86     * Returned when the quota limits set on the server have been met and/or exceeded.87     */88    QuotaExceeded = 151,89    /**90     * Returned when the Will payload in the CONNECT packet does not match the specified payload format indicator.91     */92    PayloadFormatInvalid = 153,93    /**94     * Returned when the server does not retain messages but the connection packet on the client had Will retain enabled.95     */96    RetainNotSupported = 154,97    /**98     * Returned when the server does not support the QOS setting in the Will QOS in the connection packet.99     */100    QosNotSupported = 155,101    /**102     * Returned when the server is telling the client to temporarily use another server instead of the one they103     * are trying to connect to.104     */105    UseAnotherServer = 156,106    /**107     * Returned when the server is telling the client to permanently use another server instead of the one they108     * are trying to connect to.109     */110    ServerMoved = 157,111    /**112     * Returned when the server connection rate limit has been exceeded.113     */114    ConnectionRateExceeded = 159115}116/**117 * Determines if a reason code represents a successful connect operation118 *119 * @param reasonCode reason code to check success for120 */121export declare function isSuccessfulConnectReasonCode(reasonCode: ConnectReasonCode): boolean;122/**123 * Reason code inside DISCONNECT packets.  Helps determine why a connection was terminated.124 *125 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901208) encoding values.126 */127export declare enum DisconnectReasonCode {128    /**129     * Returned when the remote endpoint wishes to disconnect normally. Will not trigger the publish of a Will message if a130     * Will message was configured on the connection.131     *132     * May be sent by the client or server.133     */134    NormalDisconnection = 0,135    /**136     * Returns that the client wants to disconnect but requires that the server publish the Will message configured137     * on the connection.138     *139     * May only be sent by the client.140     */141    DisconnectWithWillMessage = 4,142    /**143     * Returned when the connection was closed but the sender does not want to specify a reason or none144     * of the other reason codes apply.145     *146     * May be sent by the client or the server.147     */148    UnspecifiedError = 128,149    /**150     * Indicates the remote endpoint received a packet that does not conform to the MQTT specification.151     *152     * May be sent by the client or the server.153     */154    MalformedPacket = 129,155    /**156     * Returned when an unexpected or out-of-order packet was received by the remote endpoint.157     *158     * May be sent by the client or the server.159     */160    ProtocolError = 130,161    /**162     * Returned when a valid packet was received by the remote endpoint, but could not be processed by the current implementation.163     *164     * May be sent by the client or the server.165     */166    ImplementationSpecificError = 131,167    /**168     * Returned when the remote endpoint received a packet that represented an operation that was not authorized within169     * the current connection.170     *171     * May only be sent by the server.172     */173    NotAuthorized = 135,174    /**175     * Returned when the server is busy and cannot continue processing packets from the client.176     *177     * May only be sent by the server.178     */179    ServerBusy = 137,180    /**181     * Returned when the server is shutting down.182     *183     * May only be sent by the server.184     */185    ServerShuttingDown = 139,186    /**187     * Returned when the server closes the connection because no packet from the client has been received in188     * 1.5 times the KeepAlive time set when the connection was established.189     *190     * May only be sent by the server.191     */192    KeepAliveTimeout = 141,193    /**194     * Returned when the server has established another connection with the same client ID as a client's current195     * connection, causing the current client to become disconnected.196     *197     * May only be sent by the server.198     */199    SessionTakenOver = 142,200    /**201     * Returned when the topic filter name is correctly formed but not accepted by the server.202     *203     * May only be sent by the server.204     */205    TopicFilterInvalid = 143,206    /**207     * Returned when topic name is correctly formed, but is not accepted.208     *209     * May be sent by the client or the server.210     */211    TopicNameInvalid = 144,212    /**213     * Returned when the remote endpoint reached a state where there were more in-progress QoS1+ publishes then the214     * limit it established for itself when the connection was opened.215     *216     * May be sent by the client or the server.217     */218    ReceiveMaximumExceeded = 147,219    /**220     * Returned when the remote endpoint receives a PUBLISH packet that contained a topic alias greater than the221     * maximum topic alias limit that it established for itself when the connection was opened.222     *223     * May be sent by the client or the server.224     */225    TopicAliasInvalid = 148,226    /**227     * Returned when the remote endpoint received a packet whose size was greater than the maximum packet size limit228     * it established for itself when the connection was opened.229     *230     * May be sent by the client or the server.231     */232    PacketTooLarge = 149,233    /**234     * Returned when the remote endpoint's incoming data rate was too high.235     *236     * May be sent by the client or the server.237     */238    MessageRateTooHigh = 150,239    /**240     * Returned when an internal quota of the remote endpoint was exceeded.241     *242     * May be sent by the client or the server.243     */244    QuotaExceeded = 151,245    /**246     * Returned when the connection was closed due to an administrative action.247     *248     * May be sent by the client or the server.249     */250    AdministrativeAction = 152,251    /**252     * Returned when the remote endpoint received a packet where payload format did not match the format specified253     * by the payload format indicator.254     *255     * May be sent by the client or the server.256     */257    PayloadFormatInvalid = 153,258    /**259     * Returned when the server does not support retained messages.260     *261     * May only be sent by the server.262     */263    RetainNotSupported = 154,264    /**265     * Returned when the client sends a QOS that is greater than the maximum QOS established when the connection was266     * opened.267     *268     * May only be sent by the server.269     */270    QosNotSupported = 155,271    /**272     * Returned by the server to tell the client to temporarily use a different server.273     *274     * May only be sent by the server.275     */276    UseAnotherServer = 156,277    /**278     * Returned by the server to tell the client to permanently use a different server.279     *280     * May only be sent by the server.281     */282    ServerMoved = 157,283    /**284     * Returned by the server to tell the client that shared subscriptions are not supported on the server.285     *286     * May only be sent by the server.287     */288    SharedSubscriptionsNotSupported = 158,289    /**290     * Returned when the server disconnects the client due to the connection rate being too high.291     *292     * May only be sent by the server.293     */294    ConnectionRateExceeded = 159,295    /**296     * Returned by the server when the maximum connection time authorized for the connection was exceeded.297     *298     * May only be sent by the server.299     */300    MaximumConnectTime = 160,301    /**302     * Returned by the server when it received a SUBSCRIBE packet with a subscription identifier, but the server does303     * not support subscription identifiers.304     *305     * May only be sent by the server.306     */307    SubscriptionIdentifiersNotSupported = 161,308    /**309     * Returned by the server when it received a SUBSCRIBE packet with a wildcard topic filter, but the server does310     * not support wildcard topic filters.311     *312     * May only be sent by the server.313     */314    WildcardSubscriptionsNotSupported = 162315}316/**317 * Determines if a reason code represents a successful disconnect operation318 *319 * @param reasonCode reason code to check success for320 */321export declare function isSuccessfulDisconnectReasonCode(reasonCode: DisconnectReasonCode): boolean;322/**323 * Reason codes inside SUBACK packet payloads that specify the results for each subscription in the associated324 * SUBSCRIBE packet.325 *326 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901178) encoding values.327 */328export declare enum SubackReasonCode {329    /**330     * Returned when the subscription was accepted and the maximum QOS sent will be QOS 0.331     */332    GrantedQoS0 = 0,333    /**334     * Returned when the subscription was accepted and the maximum QOS sent will be QOS 1.335     */336    GrantedQoS1 = 1,337    /**338     * Returned when the subscription was accepted and the maximum QOS sent will be QOS 2.339     */340    GrantedQoS2 = 2,341    /**342     * Returned when the connection was closed but the sender does not want to specify a reason or none343     * of the other reason codes apply.344     */345    UnspecifiedError = 128,346    /**347     * Returned when the subscription was valid but the server did not accept it.348     */349    ImplementationSpecificError = 131,350    /**351     * Returned when the client was not authorized to make the subscription on the server.352     */353    NotAuthorized = 135,354    /**355     * Returned when the subscription topic filter was correctly formed but not allowed for the client.356     */357    TopicFilterInvalid = 143,358    /**359     * Returned when the packet identifier was already in use on the server.360     */361    PacketIdentifierInUse = 145,362    /**363     * Returned when a subscribe-related quota set on the server was exceeded.364     */365    QuotaExceeded = 151,366    /**367     * Returned when the subscription's topic filter was a shared subscription and the server does not support368     * shared subscriptions.369     */370    SharedSubscriptionsNotSupported = 158,371    /**372     * Returned when the SUBSCRIBE packet contained a subscription identifier and the server does not support373     * subscription identifiers.374     */375    SubscriptionIdentifiersNotSupported = 161,376    /**377     * Returned when the subscription's topic filter contains a wildcard but the server does not support378     * wildcard subscriptions.379     */380    WildcardSubscriptionsNotSupported = 162381}382/**383 * Determines if a reason code represents a successful subscribe operation384 *385 * @param reasonCode reason code to check success for386 */387export declare function isSuccessfulSubackReasonCode(reasonCode: SubackReasonCode): boolean;388/**389 * Reason codes inside UNSUBACK packet payloads that specify the results for each topic filter in the associated390 * UNSUBSCRIBE packet.391 *392 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901194) encoding values.393 */394export declare enum UnsubackReasonCode {395    /**396     * Returned when the unsubscribe was successful and the client is no longer subscribed to the topic filter on the server.397     */398    Success = 0,399    /**400     * Returned when the topic filter did not match one of the client's existing subscriptions on the server.401     */402    NoSubscriptionExisted = 17,403    /**404     * Returned when the unsubscribe of the topic filter was not accepted and the server does not want to specify a405     * reason or none of the other reason codes apply.406     */407    UnspecifiedError = 128,408    /**409     * Returned when the topic filter was valid but the server does not accept an unsubscribe for it.410     */411    ImplementationSpecificError = 131,412    /**413     * Returned when the client was not authorized to unsubscribe from that topic filter on the server.414     */415    NotAuthorized = 135,416    /**417     * Returned when the topic filter was correctly formed but is not allowed for the client on the server.418     */419    TopicFilterInvalid = 143,420    /**421     * Returned when the packet identifier was already in use on the server.422     */423    PacketIdentifierInUse = 145424}425/**426 * Determines if a reason code represents a successful unsubscribe operation427 *428 * @param reasonCode reason code to check success for429 */430export declare function isSuccessfulUnsubackReasonCode(reasonCode: UnsubackReasonCode): boolean;431/**432 * Reason code inside PUBACK packets that indicates the result of the associated PUBLISH request.433 *434 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901124) encoding values.435 */436export declare enum PubackReasonCode {437    /**438     * Returned when the (QoS 1) publish was accepted by the recipient.439     *440     * May be sent by the client or the server.441     */442    Success = 0,443    /**444     * Returned when the (QoS 1) publish was accepted but there were no matching subscribers.445     *446     * May only be sent by the server.447     */448    NoMatchingSubscribers = 16,449    /**450     * Returned when the (QoS 1) publish was not accepted and the receiver does not want to specify a reason or none451     * of the other reason codes apply.452     *453     * May be sent by the client or the server.454     */455    UnspecifiedError = 128,456    /**457     * Returned when the (QoS 1) publish was valid but the receiver was not willing to accept it.458     *459     * May be sent by the client or the server.460     */461    ImplementationSpecificError = 131,462    /**463     * Returned when the (QoS 1) publish was not authorized by the receiver.464     *465     * May be sent by the client or the server.466     */467    NotAuthorized = 135,468    /**469     * Returned when the topic name was valid but the receiver was not willing to accept it.470     *471     * May be sent by the client or the server.472     */473    TopicNameInvalid = 144,474    /**475     * Returned when the packet identifier used in the associated PUBLISH was already in use.476     * This can indicate a mismatch in the session state between client and server.477     *478     * May be sent by the client or the server.479     */480    PacketIdentifierInUse = 145,481    /**482     * Returned when the associated PUBLISH failed because an internal quota on the recipient was exceeded.483     *484     * May be sent by the client or the server.485     */486    QuotaExceeded = 151,487    /**488     * Returned when the PUBLISH packet's payload format did not match its payload format indicator property.489     *490     * May be sent by the client or the server.491     */492    PayloadFormatInvalid = 153493}494/**495 * Determines if a reason code represents a successful QoS 1 publish operation496 *497 * @param reasonCode reason code to check success for498 */499export declare function isSuccessfulPubackReasonCode(reasonCode: PubackReasonCode): boolean;500/**501 * Optional property describing a PUBLISH payload's format.502 *503 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) encoding values.504 */505export declare enum PayloadFormatIndicator {506    /**507     * The payload is arbitrary binary data508     */509    Bytes = 0,510    /**511     * The payload is a well-formed utf-8 string value.512     */513    Utf8 = 1514}515/**516 * Valid types for a PUBLISH packet's payload517 *518 * While the payload as input can be one of several types, the payload as output (via message receipt)519 * will always be an ArrayBuffer of binary data.520 */521export type Payload = string | Record<string, unknown> | ArrayBuffer | ArrayBufferView;522/**523 * Valid types for MQTT5 packet binary data fields (other than PUBLISH payload)524 */525export type BinaryData = ArrayBuffer | ArrayBufferView;526/**527 * MQTT message delivery quality of service.528 *529 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901234) encoding values.530 */531export declare enum QoS {532    /**533     * The message is delivered according to the capabilities of the underlying network. No response is sent by the534     * receiver and no retry is performed by the sender. The message arrives at the receiver either once or not at all.535     */536    AtMostOnce = 0,537    /**538     * A level of service that ensures that the message arrives at the receiver at least once.539     */540    AtLeastOnce = 1,541    /**542     * A level of service that ensures that the message arrives at the receiver exactly once.543     */544    ExactlyOnce = 2545}546/**547 * Configures how retained messages should be handled when subscribing with a topic filter that matches topics with548 * associated retained messages.549 *550 * Enum values match [MQTT5 spec](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169) encoding values.551 */552export declare enum RetainHandlingType {553    /**554     * The server should always send all retained messages on topics that match a subscription's filter.555     */556    SendOnSubscribe = 0,557    /**558     * The server should send retained messages on topics that match the subscription's filter, but only for the559     * first matching subscription, per session.560     */561    SendOnSubscribeIfNew = 1,562    /**563     * Subscriptions must not trigger any retained message publishes from the server.564     */565    DontSend = 2566}567/**568 * Packet type indicator that allows for basic polymorphism with user-received packets.  Enum values569 * match the mqtt spec's [packet type encoding](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901022) values.570 */571export declare enum PacketType {572    Connect = 1,573    Connack = 2,574    Publish = 3,575    Puback = 4,576    Pubrec = 5,577    Pubrel = 6,578    Pubcomp = 7,579    Subscribe = 8,580    Suback = 9,581    Unsubscribe = 10,582    Unsuback = 11,583    Pingreq = 12,584    Pingresp = 13,585    Disconnect = 14,586    Auth = 15587}588/**589 * Common interface for all packet types.590 */591export interface IPacket {592    /**593     * Always set on packets coming from the client to the user.  Ignored if set on packets that come from the594     * user to the client.595     *596     * The primary use is to allow users to distinguish between packets in polymorphic situations (for example,597     * the result of a publish attempt which might be a Puback (QoS 1) or Pubcomp (QoS 2, when we support it).598     */599    type?: PacketType;600}601/**602 * Data model of an [MQTT5 PUBLISH](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901100) packet603 */604export interface PublishPacket extends IPacket {605    /**606     * Sent publishes - The topic this message should be published to.607     *608     * Received publishes - The topic this message was published to.609     *610     * See [MQTT5 Topic Name](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901107)611     */612    topicName: string;613    /**614     * The payload of the publish message.615     *616     * See [MQTT5 Publish Payload](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901119)617     */618    payload?: Payload;619    /**620     * Sent publishes - The MQTT quality of service level this message should be delivered with.621     *622     * Received publishes - The MQTT quality of service level this message was delivered at.623     *624     * See [MQTT5 QoS](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901103)625     */626    qos: QoS;627    /**628     * True if this is a retained message, false otherwise.629     *630     * Always set on received publishes; on sent publishes, undefined implies false.631     *632     * See [MQTT5 Retain](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901104)633     */634    retain?: boolean;635    /**636     * Property specifying the format of the payload data.  The mqtt5 client does not enforce or use this637     * value in a meaningful way.638     *639     * See [MQTT5 Payload Format Indicator](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111)640     */641    payloadFormat?: PayloadFormatIndicator;642    /**643     * Sent publishes - indicates the maximum amount of time allowed to elapse for message delivery before the server644     * should instead delete the message (relative to a recipient).645     *646     * Received publishes - indicates the remaining amount of time (from the server's perspective) before the message would647     * have been deleted relative to the subscribing client.648     *649     * If left undefined, indicates no expiration timeout.650     *651     * See [MQTT5 Message Expiry Interval](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901112)652     */653    messageExpiryIntervalSeconds?: number;654    /**655     * Sent publishes - (Node only) topic alias to use, if possible, when encoding this packet.  Only used if the656     * client's outbound topic aliasing mode is set to Manual.657     *658     * Received publishes - topic alias used by the server when transmitting the publish to the client.659     *660     * See [MQTT5 Topic Alias](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901113)661     */662    topicAlias?: number;663    /**664     * Opaque topic string intended to assist with request/response implementations.  Not internally meaningful to665     * MQTT5 or this client.666     *667     * See [MQTT5 Response Topic](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114)668     */669    responseTopic?: string;670    /**671     * Opaque binary data used to correlate between publish messages, as a potential method for request-response672     * implementation.  Not internally meaningful to MQTT5.673     *674     * See [MQTT5 Correlation Data](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115)675     */676    correlationData?: BinaryData;677    /**678     * Sent publishes - ignored679     *680     * Received publishes - the subscription identifiers of all the subscriptions this message matched.681     *682     * See [MQTT5 Subscription Identifier](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901117)683     */684    subscriptionIdentifiers?: Array<number>;685    /**686     * Property specifying the content type of the payload.  Not internally meaningful to MQTT5.687     *688     * See [MQTT5 Content Type](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118)689     */690    contentType?: string;691    /**692     * Set of MQTT5 user properties included with the packet.693     *694     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901116)695     */696    userProperties?: Array<UserProperty>;697}698/**699 * Data model of an [MQTT5 PUBACK](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901121) packet700 */701export interface PubackPacket extends IPacket {702    /**703     * Success indicator or failure reason for the associated PUBLISH packet.704     *705     * See [MQTT5 PUBACK Reason Code](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901124)706     */707    reasonCode: PubackReasonCode;708    /**709     * Additional diagnostic information about the result of the PUBLISH attempt.710     *711     * See [MQTT5 Reason String](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901127)712     */713    reasonString?: string;714    /**715     * Set of MQTT5 user properties included with the packet.716     *717     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901128)718     */719    userProperties?: Array<UserProperty>;720}721/**722 * Data model of an [MQTT5 CONNECT](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901033) packet.723 */724export interface ConnectPacket extends IPacket {725    /**726     * The maximum time interval, in seconds, that is permitted to elapse between the point at which the client727     * finishes transmitting one MQTT packet and the point it starts sending the next.  The client will use728     * PINGREQ packets to maintain this property.729     *730     * If the responding CONNACK contains a keep alive property value, then that is the negotiated keep alive value.731     * Otherwise, the keep alive sent by the client is the negotiated value.732     *733     * See [MQTT5 Keep Alive](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901045)734     */735    keepAliveIntervalSeconds: number;736    /**737     * A unique string identifying the client to the server.  Used to restore session state between connections.738     *739     * If left empty, the broker will auto-assign a unique client id.  When reconnecting, the mqtt5 client will740     * always use the auto-assigned client id.741     *742     * See [MQTT5 Client Identifier](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901059)743     */744    clientId?: string;745    /**746     * A string value that the server may use for client authentication and authorization.747     *748     * See [MQTT5 User Name](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901071)749     */750    username?: string;751    /**752     * Opaque binary data that the server may use for client authentication and authorization.753     *754     * See [MQTT5 Password](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901072)755     */756    password?: BinaryData;757    /**758     * A time interval, in seconds, that the client requests the server to persist this connection's MQTT session state759     * for.  Has no meaning if the client has not been configured to rejoin sessions.  Must be non-zero in order to760     * successfully rejoin a session.761     *762     * If the responding CONNACK contains a session expiry property value, then that is the negotiated session expiry763     * value.  Otherwise, the session expiry sent by the client is the negotiated value.764     *765     * See [MQTT5 Session Expiry Interval](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901048)766     */767    sessionExpiryIntervalSeconds?: number;768    /**769     * If set to true, requests that the server send response information in the subsequent CONNACK.  This response770     * information may be used to set up request-response implementations over MQTT, but doing so is outside771     * the scope of the MQTT5 spec and client.772     *773     * See [MQTT5 Request Response Information](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901052)774     */775    requestResponseInformation?: boolean;776    /**777     * If set to true, requests that the server send additional diagnostic information (via response string or778     * user properties) in DISCONNECT or CONNACK packets from the server.779     *780     * See [MQTT5 Request Problem Information](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901053)781     */782    requestProblemInformation?: boolean;783    /**784     * Notifies the server of the maximum number of in-flight Qos 1 and 2 messages the client is willing to handle.  If785     * omitted, then no limit is requested.786     *787     * See [MQTT5 Receive Maximum](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901049)788     */789    receiveMaximum?: number;790    /**791     * Notifies the server of the maximum packet size the client is willing to handle.  If792     * omitted, then no limit beyond the natural limits of MQTT packet size is requested.793     *794     * See [MQTT5 Maximum Packet Size](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901050)795     */796    maximumPacketSizeBytes?: number;797    /**798     * A time interval, in seconds, that the server should wait (for a session reconnection) before sending the799     * will message associated with the connection's session.  If omitted, the server will send the will when the800     * associated session is destroyed.  If the session is destroyed before a will delay interval has elapsed, then801     * the will must be sent at the time of session destruction.802     *803     * See [MQTT5 Will Delay Interval](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901062)804     */805    willDelayIntervalSeconds?: number;806    /**807     * The definition of a message to be published when the connection's session is destroyed by the server or when808     * the will delay interval has elapsed, whichever comes first.  If undefined, then nothing will be sent.809     *810     * See [MQTT5 Will](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901040)811     */812    will?: PublishPacket;813    /**814     * Set of MQTT5 user properties included with the packet.815     *816     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901054)817     */818    userProperties?: Array<UserProperty>;819}820/**821 * Data model of an [MQTT5 CONNACK](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901074) packet.822 */823export interface ConnackPacket extends IPacket {824    /**825     * True if the client rejoined an existing session on the server, false otherwise.826     *827     * See [MQTT5 Session Present](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901078)828     */829    sessionPresent: boolean;830    /**831     * Indicates either success or the reason for failure for the connection attempt.832     *833     * See [MQTT5 Connect Reason Code](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901079)834     */835    reasonCode: ConnectReasonCode;836    /**837     * A time interval, in seconds, that the server will persist this connection's MQTT session state838     * for.  If present, this value overrides any session expiry specified in the preceding CONNECT packet.839     *840     * See [MQTT5 Session Expiry Interval](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901082)841     */842    sessionExpiryInterval?: number;843    /**844     * The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once.  If omitted,845     * the limit is based on the valid MQTT packet id space (65535).846     *847     * See [MQTT5 Receive Maximum](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901083)848     */849    receiveMaximum?: number;850    /**851     * The maximum message delivery quality of service that the server will allow on this connection.852     *853     * See [MQTT5 Maximum QoS](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901084)854     */855    maximumQos?: QoS;856    /**857     * Indicates whether the server supports retained messages.  If undefined, retained messages are858     * supported.859     *860     * See [MQTT5 Retain Available](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901085)861     */862    retainAvailable?: boolean;863    /**864     * Specifies the maximum packet size, in bytes, that the server is willing to accept.  If undefined, there865     * is no limit beyond what is imposed by the MQTT spec itself.866     *867     * See [MQTT5 Maximum Packet Size](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901086)868     */869    maximumPacketSize?: number;870    /**871     * Specifies a client identifier assigned to this connection by the server.  Only valid when the client id of872     * the preceding CONNECT packet was left empty.873     *874     * See [MQTT5 Assigned Client Identifier](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901087)875     */876    assignedClientIdentifier?: string;877    /**878     * Specifies the maximum topic alias value that the server will accept from the client.879     *880     * See [MQTT5 Topic Alias Maximum](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901088)881     */882    topicAliasMaximum?: number;883    /**884     * Additional diagnostic information about the result of the connection attempt.885     *886     * See [MQTT5 Reason String](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901089)887     */888    reasonString?: string;889    /**890     * Indicates whether the server supports wildcard subscriptions.  If undefined, wildcard subscriptions891     * are supported.892     *893     * See [MQTT5 Wildcard Subscriptions Available](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901091)894     */895    wildcardSubscriptionsAvailable?: boolean;896    /**897     * Indicates whether the server supports subscription identifiers.  If undefined, subscription identifiers898     * are supported.899     *900     * See [MQTT5 Subscription Identifiers Available](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901092)901     */902    subscriptionIdentifiersAvailable?: boolean;903    /**904     * Indicates whether the server supports shared subscription topic filters.  If undefined, shared subscriptions905     * are supported.906     *907     * See [MQTT5 Shared Subscriptions Available](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901093)908     */909    sharedSubscriptionsAvailable?: boolean;910    /**911     * Server-requested override of the keep alive interval, in seconds.  If undefined, the keep alive value sent912     * by the client should be used.913     *914     * See [MQTT5 Server Keep Alive](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901094)915     */916    serverKeepAlive?: number;917    /**918     * A value that can be used in the creation of a response topic associated with this connection.  MQTT5-based919     * request/response is outside the purview of the MQTT5 spec and this client.920     *921     * See [MQTT5 Response Information](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901095)922     */923    responseInformation?: string;924    /**925     * Property indicating an alternate server that the client may temporarily or permanently attempt926     * to connect to instead of the configured endpoint.  Will only be set if the reason code indicates another927     * server may be used (ServerMoved, UseAnotherServer).928     *929     * See [MQTT5 Server Reference](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901096)930     */931    serverReference?: string;932    /**933     * Set of MQTT5 user properties included with the packet.934     *935     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901090)936     */937    userProperties?: Array<UserProperty>;938}939/**940 * Data model of an [MQTT5 DISCONNECT](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901205) packet.941 */942export interface DisconnectPacket extends IPacket {943    /**944     * Value indicating the reason that the sender is closing the connection945     *946     * See [MQTT5 Disconnect Reason Code](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901208)947     */948    reasonCode: DisconnectReasonCode;949    /**950     * Requests a change to the session expiry interval negotiated at connection time as part of the disconnect.  Only951     * valid for  DISCONNECT packets sent from client to server.  It is not valid to attempt to change session expiry952     * from zero to a non-zero value.953     *954     * See [MQTT5 Session Expiry Interval](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901211)955     */956    sessionExpiryIntervalSeconds?: number;957    /**958     * Additional diagnostic information about the reason that the sender is closing the connection959     *960     * See [MQTT5 Reason String](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901212)961     */962    reasonString?: string;963    /**964     * Set of MQTT5 user properties included with the packet.965     *966     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901213)967     */968    userProperties?: Array<UserProperty>;969    /**970     * Property indicating an alternate server that the client may temporarily or permanently attempt971     * to connect to instead of the configured endpoint.  Will only be set if the reason code indicates another972     * server may be used (ServerMoved, UseAnotherServer).973     *974     * See [MQTT5 Server Reference](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901214)975     */976    serverReference?: string;977}978/**979 * Configures a single subscription within a Subscribe operation980 *981 * See [MQTT5 Subscription Options](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169)982 */983export interface Subscription {984    /**985     * Topic filter to subscribe to986     *987     * See [MQTT5 Subscription Options](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169)988     */989    topicFilter: string;990    /**991     * Maximum QoS on which the subscriber will accept publish messages.  Negotiated QoS may be different.992     *993     * See [MQTT5 Subscription Options](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169)994     */995    qos: QoS;996    /**997     * Should the server not send publishes to a client when that client was the one who sent the publish?  If998     * undefined, this is assumed to be false.999     *1000     * See [MQTT5 Subscription Options](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169)1001     */1002    noLocal?: boolean;1003    /**1004     * Should messages sent due to this subscription keep the retain flag preserved on the message?  If undefined,1005     * this is assumed to be false.1006     *1007     * See [MQTT5 Subscription Options](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169)1008     */1009    retainAsPublished?: boolean;1010    /**1011     * Should retained messages on matching topics be sent in reaction to this subscription?  If undefined,1012     * this is assumed to be RetainHandlingType.SendOnSubscribe.1013     *1014     * See [MQTT5 Subscription Options](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901169)1015     */1016    retainHandlingType?: RetainHandlingType;1017}1018/**1019 * Data model of an [MQTT5 SUBSCRIBE](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901161) packet.1020 */1021export interface SubscribePacket extends IPacket {1022    /**1023     * List of topic filter subscriptions that the client wishes to listen to1024     *1025     * See [MQTT5 Subscribe Payload](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901168)1026     */1027    subscriptions: Array<Subscription>;1028    /**1029     * A positive integer to associate with all subscriptions in this request.  Publish packets that match1030     * a subscription in this request should include this identifier in the resulting message.1031     *1032     * See [MQTT5 Subscription Identifier](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901166)1033     */1034    subscriptionIdentifier?: number;1035    /**1036     * Set of MQTT5 user properties included with the packet.1037     *1038     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901167)1039     */1040    userProperties?: Array<UserProperty>;1041}1042/**1043 * Data model of an [MQTT5 SUBACK](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901171) packet.1044 */1045export interface SubackPacket extends IPacket {1046    /**1047     * A list of reason codes indicating the result of each individual subscription entry in the1048     * associated SUBSCRIBE packet.1049     *1050     * See [MQTT5 Suback Payload](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901178)1051     */1052    reasonCodes: Array<SubackReasonCode>;1053    /**1054     * Additional diagnostic information about the result of the SUBSCRIBE attempt.1055     *1056     * See [MQTT5 Reason String](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901176)1057     */1058    reasonString?: string;1059    /**1060     * Set of MQTT5 user properties included with the packet.1061     *1062     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901177)1063     */1064    userProperties?: Array<UserProperty>;1065}1066/**1067 * Data model of an [MQTT5 UNSUBSCRIBE](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901179) packet.1068 */1069export interface UnsubscribePacket extends IPacket {1070    /**1071     * List of topic filters that the client wishes to unsubscribe from.1072     *1073     * See [MQTT5 Unsubscribe Payload](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901185)1074     */1075    topicFilters: Array<string>;1076    /**1077     * Set of MQTT5 user properties included with the packet.1078     *1079     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901184)1080     */1081    userProperties?: Array<UserProperty>;1082}1083/**1084 * Data model of an [MQTT5 UNSUBACK](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901187) packet.1085 */1086export interface UnsubackPacket extends IPacket {1087    /**1088     * A list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the1089     * associated UNSUBSCRIBE packet.1090     *1091     * See [MQTT5 Unsuback Payload](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901194)1092     */1093    reasonCodes: Array<UnsubackReasonCode>;1094    /**1095     * Additional diagnostic information about the result of the UNSUBSCRIBE attempt.1096     *1097     * See [MQTT5 Reason String](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901192)1098     */1099    reasonString?: string;1100    /**1101     * Set of MQTT5 user properties included with the packet.1102     *1103     * See [MQTT5 User Property](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901193)1104     */1105    userProperties?: Array<UserProperty>;1106}1107