Skip to content

Commit

Permalink
Merge branch 'main' into NapiSearchPath
Browse files Browse the repository at this point in the history
  • Loading branch information
bretambrose authored Jan 11, 2024
2 parents dbcad33 + 6fa0c53 commit aea3f09
Show file tree
Hide file tree
Showing 60 changed files with 3,348 additions and 890 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
- 'docs'

env:
BUILDER_VERSION: v0.9.46
BUILDER_VERSION: v0.9.53
BUILDER_SOURCE: releases
BUILDER_HOST: https://d19elf31gohf1l.cloudfront.net
PACKAGE_NAME: aws-crt-nodejs
Expand All @@ -30,7 +30,6 @@ jobs:
- al2-x64
- manylinux2014-aarch64
- manylinux2014-x64
- manylinux2014-x86
- fedora-34-x64
- opensuse-leap
- rhel8-x64
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/stale_issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ jobs:
cleanup:
runs-on: ubuntu-latest
name: Stale issue job
permissions:
issues: write
pull-requests: write
steps:
- uses: aws-actions/stale-issue-cleanup@v3
with:
Expand Down
17 changes: 4 additions & 13 deletions MQTT5-UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Table of contents

* [Developer Preview Disclaimer](#developer-preview-disclaimer)
* [What's Different? (relative to the MQTT311 implementation)](#whats-different-relative-to-the-mqtt311-implementation)
* [Major changes](#major-changes)
* [Minor changes](#minor-changes)
Expand Down Expand Up @@ -37,14 +36,6 @@ Complete API documentation for the CRT's MQTT5 client can be found for
* [NodeJS](https://awslabs.github.io/aws-crt-nodejs/node/modules/mqtt5.html)
* [Browser](https://awslabs.github.io/aws-crt-nodejs/browser/modules/mqtt5.html)

## Developer Preview Disclaimer
MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window
is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the
public API, but in general, this is something we will try our best to avoid.

The MQTT5 client cannot yet be used with the AWS IoT MQTT services (Shadow, Jobs, Identity). We plan to
address this in the near future.

## What's Different? (relative to the MQTT311 implementation)
SDK MQTT5 support comes from a separate client implementation. By doing so, we took the opportunity to incorporate
feedback about the MQTT311 implementation that we could not apply without making breaking changes. If you're used to the MQTT311
Expand Down Expand Up @@ -369,9 +360,9 @@ If your custom authenticator does not use signing, you don't specify anything re
let client : Mqtt5Client = new mqtt5.Mqtt5Client(builder.build());
```

If your custom authorizer uses signing, you must specify the three signed token properties as well. The token signature must be
the URI-encoding of the base64 encoding of the digital signature of the token value via the private key associated with the public key
that was registered with the custom authorizer. It is your responsibility to URI-encode the token signature:
If your custom authorizer uses signing, you must specify the three signed token properties as well. The token signature should be
the base64 encoding of the digital signature of the token value via the private key associated with the public key
that was registered with the custom authorizer:

```typescript
let customAuthConfig : MqttConnectCustomAuthConfig = {
Expand All @@ -380,7 +371,7 @@ that was registered with the custom authorizer. It is your responsibility to UR
password: <Binary data value of the password field to be passed to the authorizer lambda>,
tokenKeyName: "<Name of the username query param that will contain the token value>",
tokenValue: "<Value of the username query param that holds the token value that has been signed>",
tokenSignature: "<URI-encoded base64-encoded digital signature of tokenValue>"
tokenSignature: "<base64-encoded digital signature of tokenValue>"
};
let builder = AwsIotMqtt5ClientConfigBuilder.newDirectMqttBuilderWithCustomAuth(
"<account-specific endpoint>",
Expand Down
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,14 @@ NodeJS/Browser bindings for the AWS Common Runtime

[API Docs](https://awslabs.github.io/aws-crt-nodejs/)

## Impending Node Version Update
In the coming months, the AWS Common Runtime will be updating its Node baseline from 10.16 to 14. A
[discussion thread](https://github.com/awslabs/aws-crt-nodejs/discussions/468)
has been created for any questions or feedback you may have. We do not yet have a concrete timeline for when the
update will happen.

## License

This library is licensed under the Apache 2.0 License.

## Building the package

### Prereqs:
* Node 10.16+
* Node 14+
* npm
* CMake 3.1+
* Linux: gcc 5+ or clang 3.6+
Expand Down
4 changes: 2 additions & 2 deletions builder.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "aws-crt-nodejs",
"+imports": [
"node-12",
"node-14",
"JDK8"
],
"+packages": [
Expand Down Expand Up @@ -65,7 +65,7 @@
},
"al2012": {
"!packages": [],
"!imports": [ "node-12" ]
"!imports": [ "node-14" ]
}
},
"targets": {
Expand Down
Loading

0 comments on commit aea3f09

Please sign in to comment.