moved MQTT5 User Guide and fixed links

Author: sbSteveK

README.md

@@ -13,7 +13,7 @@ The AWS IoT Device SDK for JavaScript v2 connects your JavaScript applications a
   * [Installing from npm](#installing-from-npm)
 * [Getting Started](#getting-started)
 * [Samples](samples)
-* [MQTT5 User Guide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md)
+* [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
 * [Getting Help](#getting-help)
 * [Resources](#resources)
 
@@ -23,7 +23,7 @@ The primary purpose of the AWS IoT Device SDK for JavaScript v2 is to simplify t
 
 * Integrated service clients for AWS IoT Core services
 * Secure device connections to AWS IoT Core using MQTT protocol including MQTT 5.0
-* Support for [multiple authentication methods and connection types](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#how-to-create-an-mqtt5-client-based-on-desired-connection-method)
+* Support for [multiple authentication methods and connection types](./documents/MQTT5_Userguide.md#how-to-create-an-mqtt5-client-based-on-desired-connection-method)
 
 #### Supported AWS IoT Core services
 
@@ -63,11 +63,11 @@ To get started with the AWS IoT Device SDK for JavaScript v2:
 
 1. **Install the SDK** - See the [Installation](#installation) section for installation details
 
-2. **Choose your connection method** - The SDK supports multiple authentication methods including X.509 certificates, AWS credentials, and custom authentication. [MQTT5 User Guide connection section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#connecting-to-aws-iot-core) provides more guidance
+2. **Choose your connection method** - The SDK supports multiple authentication methods including X.509 certificates, AWS credentials, and custom authentication. [MQTT5 User Guide connection section](./documents/MQTT5_Userguide.md#connecting-to-aws-iot-core) provides more guidance
 
 3. **Follow a complete example** - Check out the [samples](samples) directory
 
-4. **Learn MQTT5 features** - For advanced usage and configuration options, see the [MQTT5 User Guide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md)
+4. **Learn MQTT5 features** - For advanced usage and configuration options, see the [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
 
 The samples provide ready-to-run code with detailed setup instructions for each authentication method and use case.
 
@@ -96,7 +96,7 @@ Check out our resources for additional guidance too before opening an issue:
 
 * [FAQ](./documents/FAQ.md)
 * [AWS IoT Core Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html)
-* [MQTT5 User Guide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md)
+* [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
 * [API Docs](https://aws.github.io/aws-iot-device-sdk-js-v2/)
 * [AWS IoT Core Documentation](https://docs.aws.amazon.com/iot/)
 * [Dev Blog](https://aws.amazon.com/blogs/iot/category/internet-of-things/)

documents/FAQ.md

@@ -11,6 +11,7 @@
 * [Vercel/pkg Support](#vercel/pkg-support)
 * [Where can I find MQTT 311 Samples?](#where-can-i-find-mqtt-311-samples)
 * [Certificate and Private Key Usage Across Different Versions of the SDK on macOS](#certificate-and-private-key-usage-across-different-versions-of-the-sdk-on-macos)
+* [Manual Publish Acknowledgement and QoS 1 Redelivery](#manual-publish-acknowledgement-and-qos-1-redelivery)
 * [I still have more questions about this sdk?](#i-still-have-more-questions-about-this-sdk)
 
 ### Where should I start?
@@ -131,6 +132,18 @@ The MQTT 311 Samples can be found in the v1.23.0 samples folder [here](https://g
 ### Certificate and Private Key Usage Across Different Versions of the SDK on macOS
 A certificate and private key pair cannot be shared on a macOS device between aws-iot-device-sdk-js-v2 v1.24.0 and an earlier version. In the update to v1.24.0 we migrated macOS from using Apple's deprecated Security Framework to SecItem API. In doing so, certificate and private keys are imported in a non-backwards compatible manner into the Apple Keychain.
 
+### Manual Publish Acknowledgement and QoS 1 Redelivery
+
+When using [manual publish acknowledgement](./MQTT5_Userguide.md#manual-publish-acknowledgement), there are two important behaviors to be aware of regarding QoS 1 message redelivery:
+
+**Broker redelivery of unacknowledged publishes**
+
+The AWS IoT broker will periodically resend unacknowledged QoS 1 PUBLISH packets. These redeliveries should be treated as duplicates even if the DUP flag in the PUBLISH packet is not set. If the manual publish acknowledgement is not acquired again for a redelivered packet, the acknowledgement will be sent automatically.
+
+**Session resumption after disconnect/reconnect**
+
+Upon a disconnect and reconnect of the MQTT5 client, if a session is resumed, any previously acquired acknowledgement handle is void. The broker will resend the unacknowledged PUBLISH packet, and the acknowledgement must be reacquired from that resent packet. If the resent packet is not handled for manual acknowledgement, the acknowledgement will be sent automatically.
+
 ### I still have more questions about this sdk?
 
 * [Here](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) are the AWS IoT Core docs for more details about IoT Core

documents/MIGRATION_GUIDE.md

@@ -42,7 +42,7 @@ are new in the v2 SDK, and provides guidance on how to migrate your code to v2 f
 
 Public APIs for almost all actions and operations have changed significantly. There're differences between the v1 SDK and
 the v2 SDK. This section describes the changes you need to apply to your project with the v1 SDK to start using the v2 SDK.
-For more information about MQTT5, visit [MQTT5 User Guide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md).
+For more information about MQTT5, visit [MQTT5 User Guide](./MQTT5_Userguide.md).
 
 ### Package name change
 
@@ -162,22 +162,22 @@ WebSocket using a custom authorization function to authenticate.
 The v2 SDK adds a collection of connection types and cryptography formats (e.g. [PKCS #11](https://en.wikipedia.org/wiki/PKCS_11)),
 credential providers (e.g. [Windows Certificate Store](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores)),
 and other connection-related features.\
-For more information, refer to the [Connecting to AWS IoT Core](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#connecting-to-aws-iot-core)
+For more information, refer to the [Connecting to AWS IoT Core](./MQTT5_Userguide.md#connecting-to-aws-iot-core)
 section of the MQTT5 user guide for detailed information and code snippets on each connection type and connection feature.
 
 > [!NOTE]
 > Both v1 and v2 SDKs support only SigV4 and Custom authentication in browser environment.
 
 | Connection type/feature                                                | v1 SDK - Node.js                                  | v1 SDK - browser                                  | v2 SDK - Node.js                  | v2 SDK - browser                  |User guide section|
 |------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------|-----------------------------------|-----------------------------------|------------------|
-| MQTT over Secure WebSocket with AWS SigV4 authentication               | $${\Large\color{green}✔}$$                 | $${\Large\color{green}✔}$$                 | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication-1) |
-| MQTT over Secure WebSocket with Cognito Authentication Method          | $${\Large\color{green}✔}$$                 | $${\Large\color{green}✔}$$                 | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) |
-| MQTT over Secure WebSocket with Custom Authentication                  | $${\Large\color{green}✔}$$                 | $${\Large\color{green}✔}$$                 | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-custom-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-custom-authentication) |
-| MQTT (over TLS 1.2) with X.509 certificate based mutual authentication | $${\Large\color{green}✔}$$                 | $${\Large\color{red}✘}$$                   | $${\Large\color{green}✔}$$ | $${\Large\color{red}✘}$$   | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-x509-based-mutual-tls) |
-| MQTT with PKCS12 Method                                                | $${\Large\color{orange}&#10004;}$$<sup>\*</sup>   | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs12-method) |
-| MQTT with Windows Certificate Store Method                             | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-windows-certificate-store-method) |
-| MQTT with PKCS11 Method                                                | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs11-method) |
-| HTTP Proxy                                                             | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{green}&#10004;}$$ | $${\Large\color{green}&#10004;}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy-1) |
+| MQTT over Secure WebSocket with AWS SigV4 authentication               | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{green}&#10004;}$$ | $${\Large\color{green}&#10004;}$$ | [Node.js section](./MQTT5_Userguide.md#mqtt-over-websockets-with-sigv4-authentication) [Browser section](./MQTT5_Userguide.md#mqtt-over-websockets-with-sigv4-authentication-1) |
+| MQTT over Secure WebSocket with Cognito Authentication Method          | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{green}&#10004;}$$ | $${\Large\color{green}&#10004;}$$ | [Node.js section](./MQTT5_Userguide.md#mqtt-over-websockets-with-sigv4-authentication) |
+| MQTT over Secure WebSocket with Custom Authentication                  | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{green}&#10004;}$$ | $${\Large\color{green}&#10004;}$$ | [Node.js section](./MQTT5_Userguide.md#direct-mqtt-with-custom-authentication) [Browser section](./MQTT5_Userguide.md#mqtt-over-websockets-with-custom-authentication) |
+| MQTT (over TLS 1.2) with X.509 certificate based mutual authentication | $${\Large\color{green}&#10004;}$$                 | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](./MQTT5_Userguide.md#direct-mqtt-with-x509-based-mutual-tls) |
+| MQTT with PKCS12 Method                                                | $${\Large\color{orange}&#10004;}$$<sup>\*</sup>   | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](./MQTT5_Userguide.md#direct-mqtt-with-pkcs12-method) |
+| MQTT with Windows Certificate Store Method                             | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](./MQTT5_Userguide.md#direct-mqtt-with-windows-certificate-store-method) |
+| MQTT with PKCS11 Method                                                | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{red}&#10008;}$$                   | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$   | [Node.js section](./MQTT5_Userguide.md#direct-mqtt-with-pkcs11-method) |
+| HTTP Proxy                                                             | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{green}&#10004;}$$ | $${\Large\color{green}&#10004;}$$ | [Node.js section](./MQTT5_Userguide.md#http-proxy) [Browser section](./MQTT5_Userguide.md#http-proxy-1) |
 
 ${\Large\color{orange}&#10004;}$<sup>\*</sup> - To get this connection type work in the v1 SDK, you need to extract a private key from a PKCS #12 file.\
 ${\Large\color{orange}&#10004;}$<sup>\*\*</sup> - The v1 SDK does not allow specifying HTTP proxy, but it is possible to configure systemwide proxy.
@@ -238,7 +238,7 @@ You can supply a custom callback function via `on` method of the `device` instan
 events callbacks to help determine the state of the MQTT client during operation.
 
 The v2 SDK defines its own set of lifecycle events: *AttemptingConnect*, *ConnectionSuccess*, *ConnectionFailure*, *Disconnect*,
-and *Stopped*. For more information, refer to the [MQTT5 user guide](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#client-events).
+and *Stopped*. For more information, refer to the [MQTT5 user guide](./MQTT5_Userguide.md#client-events).
 
 #### Example of setting lifecycle events in the v1 SDK