auth0 / node-jwa

JSON Web Algorithms
http://tools.ietf.org/id/draft-ietf-jose-json-web-algorithms-08.html
MIT License
99 stars 41 forks source link

Rewrite in Typescript #37

Open jharrilim opened 5 years ago

jharrilim commented 5 years ago

Hi, I am currently in the progress of rewriting this and node-jws in Typescript. I noticed a few lingering issues in node-jws so I figured I'd give it a rewrite. It relies on node-jwa which does not have types included. The aim of this rewrite is to hopefully increase the maintainability and hardiness.

For now the code is nearly one-to-one with the original with a few new runtime assertions. The tests are currently being rewritten to take advantage of jest. The RFC 7515 - Appendix A examples have been rewritten so far and currently pass. The other examples will be converted soon.

Edit: I have removed support for Node versions that are no longer supported in travis.yml as well as added the package-lock.json so that npm ci is usable.

The keys for testing are now permanently added as test fixtures.

Automated documentation can now be done using Typedoc. This should work in tandem with Travis Github Pages deployments.

grzegorzjudas commented 4 years ago

@jharrilim amazing work!

Do you still have something left to change/rewrite? I could help if so, because I'd also like to have the typings available. Cheers!

jharrilim commented 4 years ago

Hi there! It has been a while since I touched this, but from what I remember the code should work exactly the same. After a quick glance right now though, I have noticed that a few things are missing from the package.json, which I think might be necessary:

{
  "publishConfig": {
    "access": "public"
  },
  "files": [
    "/lib"
  ]
}