@cardano-foundation/ledgerjs-hw-app-cardano - npm Package Compare versions

Comparing version 2.2.1 to 3.0.0

package.json

 {
   "name": "@cardano-foundation/ledgerjs-hw-app-cardano",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "files": [
-    "lib"
+    "dist"
   ],
+  "types": "./dist/Ada.d.ts",
   "description": "Ledger Hardware Wallet Cardano ADA API",
-  "main": "lib/Ada.js",
+  "main": "dist/Ada.js",
   "repository": "github:cardano-foundation/ledgerjs-hw-app-cardano",
@@ -24,4 +25,3 @@ "keywords": [
     "@ledgerhq/hw-transport": "^5.12.0",
-    "babel-polyfill": "^6.26.0",
-    "babel-runtime": "^6.26.0",
+    "@types/ledgerhq__hw-transport": "^4.21.3",
     "base-x": "^3.0.5",
@@ -32,15 +32,27 @@ "bech32": "^1.1.4",
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-transform-runtime": "^7.9.0",
-    "@babel/preset-env": "^7.9.0",
-    "@babel/preset-flow": "^7.9.0",
     "@ledgerhq/hw-transport-node-hid": "^5.12.0",
+    "@types/chai": "^4.2.15",
+    "@types/chai-as-promised": "^7.1.3",
+    "@types/ledgerhq__hw-transport-node-hid": "^4.22.2",
+    "@types/mocha": "^8.2.1",
+    "@types/node": "^14.14.28",
+    "@typescript-eslint/eslint-plugin": "^4.15.0",
+    "@typescript-eslint/parser": "^4.15.0",
     "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "chalk": "^4.0.0",
-    "flow-bin": "^0.131.0",
-    "flow-copy-source": "^2.0.9",
-    "flow-typed": "^3.1.0",
+    "eslint": "^7.19.0",
+    "eslint-import-resolver-typescript": "^2.3.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-mocha": "^8.0.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
+    "eslint-plugin-typescript": "^0.14.0",
+    "gh-pages": "^3.1.0",
     "mocha": "^7.1.1",
-    "prettier": "^2.0.3"
+    "prettier": "^2.2.1",
+    "prettier-eslint": "^12.0.0",
+    "ts-node": "^9.1.1",
+    "typedoc": "git+ssh://[e-mail]:ppershing/typedoc.git#do_not_sort_properties",
+    "typescript": "^4.1.5"
   },
@@ -52,19 +64,14 @@ "bugs": {
   "scripts": {
-    "flow": "flow",
-    "clean": "bash ./script/clean.sh",
-    "build": "bash ./script/build.sh",
-    "watch": "bash ./script/watch.sh",
+    "prepare": "cd node_modules/typedoc && yarn install && yarn build",
+    "lint": "yarn eslint .",
+    "clean": "rm -rf dist/",
+    "build": "yarn tsc -p src/tsconfig.json",
+    "gen-docs": "yarn typedoc",
     "prepublish": "yarn run clean && yarn run build",
-    "build-example": "bash ./script/build_example.sh",
-    "clean-test": "rm -rf test/lib",
-    "build-test": "yarn run clean && yarn run build && yarn run clean-test && babel --source-maps -d test/lib test/src && flow-copy-source -v test/src test/lib",
-    "test": "yarn build-test && yarn test-device-run && yarn test-direct-run && yarn test-integration-run",
-    "test-device": "yarn run build-test && mocha --timeout 3600000 test/lib/device",
-    "test-device-run": "mocha --timeout 3600000 test/lib/device",
-    "test-direct": "yarn build-test && yarn test-direct-run",
-    "test-direct-run": "mocha --timeout 3600000 test/lib/direct",
-    "test-integration": "yarn run build-test && yarn run test-integration-run",
-    "test-integration-run": "mocha --timeout 600000 test/lib/integration",
+    "run-example": "yarn ts-node -P example-node/tsconfig.json example-node/index.ts",
+    "device-self-test": "mocha --timeout 3600000 -r ts-node/register test/device-self-test/**/*.test.ts",
+    "test-all": "yarn device-self-test && yarn test-integration",
+    "test-integration": "yarn mocha --timeout 3600000 -r ts-node/register test/integration/**/*.test.ts",
     "//": "run single test by specifying --grep <name> parameter in test-integration"
   }
 }

README.md

@@ -10,5 +10,4 @@ ![image](https://user-images.githubusercontent.com/837681/53001830-d7c8a600-342b-11e9-9038-e745cc91e543.png)
 
-Example code interacting with `hw-app-cardano` is provided in `example_node` directory.
-To compile run `yarn build-example`.
-Run example by `node example-node/lib/index.js`.
+Example code interacting with `hw-app-cardano` is provided in `example-node` directory.
+You can execute it with the `yarn run-example` command.
 
@@ -20,2 +19,10 @@ ### Tests
 1. `yarn test-integration`. Tests JS api.
-2. `yarn test-direct`. Mostly tests vartious corner cases. There are some extensive tests which are disabled by default, see tests source code. Also note that for these tests it is advised to install developer version of Cardano app with _headless_ mode enabled, otherwise you spend your entire life confirming various prompts on device.
+2. `yarn test-direct`. Mostly tests for different corner cases. There are some extensive tests which are disabled by default, see tests source code.
+
+Note that for these tests it is advisable to install the developer build of the Cardano app with _headless_ mode enabled unless you want to verify the UI flows, otherwise you will need a significant amount of time to manually confirm all prompts on the device.
+
+### Documentation
+
+- you can build the docs by running `yarn gen-docs` and then navigate to docs_generated/index.html
+- generated docs can also be found at (https://vacuumlabs.github.io/ledgerjs-cardano-shelley)
+- [CHANGELOG](CHANGELOG.md)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

5

decreased by-16.67%

Number of package files

112

increased by833.33%

Lines of code

2817

increased by23.01%

Number of lines in readme file

27

increased by35%

Worsened metrics

Total package byte prevSize

263465

decreased by-19.14%

Dev dependency count

25

increased by92.31%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@types/ledgerhq__hw-transport@^4.21.3

• + Added@types/ledgerhq__hw-transport@4.21.8(transitive)

• + Added@types/node@22.10.1(transitive)

• + Addedundici-types@6.20.0(transitive)

• - Removedbabel-polyfill@^6.26.0

• - Removedbabel-runtime@^6.26.0

• - Removedbabel-polyfill@6.26.0(transitive)

• - Removedbabel-runtime@6.26.0(transitive)

• - Removedcore-js@2.6.12(transitive)

• - Removedregenerator-runtime@0.10.50.11.1(transitive)