https://github.com/awslabs/aws-crt-nodejs

NodeJS bindings for the AWS Common Runtime.

https://github.com/awslabs/aws-crt-nodejs

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary

Keywords

hacktoberfest

Keywords from Contributors

aws-sdk resilience archival embedded interactive projection generic sequences diagram distribution
Last synced: 10 months ago · JSON representation

Repository

NodeJS bindings for the AWS Common Runtime.

Basic Info
  • Host: GitHub
  • Owner: awslabs
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 5.18 MB
Statistics
  • Stars: 43
  • Watchers: 17
  • Forks: 29
  • Open Issues: 21
  • Releases: 154
Topics
hacktoberfest
Created over 7 years ago · Last pushed 11 months ago
Metadata Files
Readme Contributing License Code of conduct

README.md

AWS CRT JS

NodeJS/Browser bindings for the AWS Common Runtime

API Docs

License

This library is licensed under the Apache 2.0 License.

Building the package

Prereqs:

  • Node 14+
  • npm
  • CMake 3.1+
  • Linux: gcc 5+ or clang 3.6+
    • If your compiler can compile node, it can compile this library
  • Windows: Visual Studio 2015+
  • OSX: XCode or brew-installed llvm

To build the package locally bash git clone https://github.com/awslabs/aws-crt-nodejs.git cd aws-crt-nodejs git submodule update --init npm install

Using From Your NodeJS Application

Normally, you just declare aws-crt as a dependency in your package.json file.

Using From Your Browser Application

You can either add it to package.json (if using a tool like webpack), or just import the dist.browser/ folder into your web project

Installing from npm

bash npm install aws-crt

To reduce the size of package, we put the C source code in the S3 bucket. If the platform you are using doesn't have the prebuilt binary, the install script will pull the source from S3 bucket. In case of no public internet access, you can specify the "CRTBINARYHOST" environment variable for the host of the source code. The build script will fetch source code from that host instead. To fetch the source from S3, you can reach to the cloudfront distribution (Only works for version after v1.9.2) https://d332vdhbectycy.cloudfront.net/aws-crt-<version>-source.tgz, the sha256 checksum https://d332vdhbectycy.cloudfront.net/aws-crt-<version>-source.sha256

Debug C part of code

After building the package locally, use node ./scripts/build.js --debug to enable debug. Then, attach any C debugger to use node to run jest

Mac-Only TLS Behavior

Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.1.11, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:

static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.

Owner

  • Name: Amazon Web Services - Labs
  • Login: awslabs
  • Kind: organization
  • Location: Seattle, WA

AWS Labs

GitHub Events

Total
  • Create event: 58
  • Issues event: 4
  • Release event: 13
  • Watch event: 2
  • Delete event: 33
  • Issue comment event: 25
  • Push event: 143
  • Pull request review comment event: 18
  • Pull request review event: 35
  • Pull request event: 83
  • Fork event: 2
Last Year
  • Create event: 58
  • Issues event: 4
  • Release event: 13
  • Watch event: 2
  • Delete event: 33
  • Issue comment event: 25
  • Push event: 143
  • Pull request review comment event: 18
  • Pull request review event: 35
  • Pull request event: 83
  • Fork event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 401
  • Total Committers: 27
  • Avg Commits per committer: 14.852
  • Development Distribution Score (DDS): 0.766
Past Year
  • Commits: 38
  • Committers: 10
  • Avg Commits per committer: 3.8
  • Development Distribution Score (DDS): 0.816
Top Committers
Name Email Commits
Bret Ambrose b****e@g****m 94
Justin Boswell b****j@a****m 63
Michael Graeb g****m@a****m 45
Dengke Tang 8****5@q****m 43
Colden Cullen c****n@c****m 25
Vera Xia z****a@a****m 22
TwistedTwigleg n****d@a****m 22
Steve Kim 8****K 13
Igor Abdrakhimov o****c@g****m 10
dependabot[bot] 4****] 10
Waqar Ahmed Khan w****7@g****m 9
James Siri j****i@a****m 7
David Oguns 3****S 7
Dmitriy Musatkin 6****n 6
Ryan Carper 5****r 4
Joseph Klix j****x@g****m 4
Alfred G 2****g 3
ilevyor 8****r 3
Jonathan M. Henson h****o@a****m 3
Andrew Tang t****1@1****m 1
Ashish Dhingra 6****a 1
Chase Coalwell c****l@g****m 1
Orgad Shaneh o****s@g****m 1
Sohibe Alhabroosh s****e@g****m 1
Trivikram Kamat 1****r 1
Yasmine Talby 1****y 1
sunhubs s****s@1****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 57
  • Total pull requests: 292
  • Average time to close issues: 8 months
  • Average time to close pull requests: 29 days
  • Total issue authors: 49
  • Total pull request authors: 22
  • Average comments per issue: 4.35
  • Average comments per pull request: 0.39
  • Merged pull requests: 180
  • Bot issues: 0
  • Bot pull requests: 27
Past Year
  • Issues: 5
  • Pull requests: 83
  • Average time to close issues: 10 days
  • Average time to close pull requests: 6 days
  • Issue authors: 4
  • Pull request authors: 13
  • Average comments per issue: 0.4
  • Average comments per pull request: 0.14
  • Merged pull requests: 54
  • Bot issues: 0
  • Bot pull requests: 9
Top Authors
Issue Authors
  • trivikr (3)
  • massi-ang (3)
  • samuelplexcelon (2)
  • revmischa (2)
  • mikelpr (2)
  • bretambrose (2)
  • richarddd (1)
  • Aozine (1)
  • twiking (1)
  • frankrowe (1)
  • shawngardner (1)
  • aBurmeseDev (1)
  • FedericoBiro (1)
  • jaas666 (1)
  • MonPetitUd (1)
Pull Request Authors
  • bretambrose (79)
  • xiazhvera (37)
  • sbSteveK (22)
  • dependabot[bot] (22)
  • sfod (22)
  • waahm7 (19)
  • TingDaoK (19)
  • graebm (17)
  • TwistedTwigleg (15)
  • DmitriyMusatkin (9)
  • jmklix (8)
  • alfred2g (4)
  • github-actions[bot] (3)
  • MakendranG (2)
  • ashishdhingra (2)
Top Labels
Issue Labels
feature-request (16) bug (13) p2 (10) CRT/IoT (8) needs-triage (7) p3 (5) response-requested (5) closed-for-staleness (5) p1 (3) closing-soon (2) pending-release (2) guidance (1) CRT/SDK (1) investigating (1) dependencies (1) documentation (1)
Pull Request Labels
dependencies (22) javascript (6) CRT/IoT (3) breaking-change (1)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 2,094,126 last-month
  • Total docker downloads: 1,433,174
  • Total dependent packages: 34
  • Total dependent repositories: 540
  • Total versions: 135
  • Total maintainers: 4
npmjs.org: aws-crt

NodeJS/browser bindings to the aws-c-* libraries

  • Versions: 135
  • Dependent Packages: 34
  • Dependent Repositories: 540
  • Downloads: 2,094,126 Last month
  • Docker Downloads: 1,433,174
Rankings
Downloads: 0.2%
Docker downloads count: 0.4%
Dependent repos count: 0.7%
Dependent packages count: 0.9%
Average: 2.4%
Forks count: 5.1%
Stargazers count: 6.9%
Last synced: 11 months ago

Dependencies

package-lock.json npm
  • 547 dependencies
package.json npm
  • @types/crypto-js ^3.1.43 development
  • @types/jest ^27.0.1 development
  • @types/node ^10.17.54 development
  • @types/prettier 2.6.0 development
  • @types/puppeteer ^5.4.4 development
  • @types/uuid ^3.4.8 development
  • @types/ws ^7.4.7 development
  • aws-sdk ^2.848.0 development
  • jest ^27.2.1 development
  • jest-puppeteer ^5.0.4 development
  • jest-runtime ^27.2.1 development
  • puppeteer ^3.3.0 development
  • ts-jest ^27.0.5 development
  • typedoc ^0.22.18 development
  • typedoc-plugin-merge-modules ^3.1.0 development
  • typescript ^4.7.4 development
  • uuid ^8.3.2 development
  • yargs ^17.2.1 development
  • @httptoolkit/websocket-stream ^6.0.0
  • axios ^0.24.0
  • cmake-js 6.3.0
  • crypto-js ^4.0.0
  • fastestsmallesttextencoderdecoder ^1.0.22
  • mqtt ^4.3.7
  • tar ^6.1.11
  • ws ^7.5.5
samples/browser/http/package.json npm
  • @types/jquery ^3.3.30 development
  • node-polyfill-webpack-plugin ^1.1.4 development
  • source-map-loader ^4.0.0 development
  • ts-loader ^9.3.1 development
  • typescript ^4.7.4 development
  • webpack ^5.73.0 development
  • webpack-cli ^4.10.0 development
  • aws-crt file:../../../
  • jquery ^3.5.0
samples/browser/pub_sub/package.json npm
  • @types/jquery ^3.3.31 development
  • node-polyfill-webpack-plugin ^1.1.4 development
  • source-map-loader ^4.0.0 development
  • ts-loader ^9.3.1 development
  • typescript ^4.7.4 development
  • webpack ^5.73.0 development
  • webpack-cli ^4.10.0 development
  • aws-crt file:../../../
  • aws-sdk ^2.585.0
  • jquery ^3.5.0
  • util ^0.12.4
samples/node/elasticurl/package.json npm
  • @types/node ^10.17.17 development
  • typescript ^4.7.4 development
  • aws-crt file:../../../
  • yargs ^17.2.1
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • awslabs/aws-crt-builder/.github/actions/check-submodules main composite
.github/workflows/clang-format.yml actions
  • DoozyX/clang-format-lint-action v0.3.1 composite
  • actions/checkout v1 composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • ad-m/github-push-action v0.6.0 composite
canary/mqtt5/package.json npm
  • @types/node ^10.17.17 development
  • typescript ^3.8.3 development
  • aws-crt file:../../
  • weighted-random 0.1.0
  • yargs ^17.2.1
.github/workflows/closed-issue-message.yml actions
  • aws-actions/closed-issue-message v1 composite
.github/workflows/handle-stale-discussions.yml actions
  • aws-github-ops/handle-stale-discussions v1 composite
.github/workflows/stale_issue.yml actions
  • aws-actions/stale-issue-cleanup v3 composite
scripts/build_dependencies/package.json npm