opengovsg / formsg-javascript-sdk / 262

94%

push

travis-ci-com

refactor: update crypto HOF to Crypto class (#36)

* feat: add util/crypto.ts for helper methods used by new Crypto class

* feat: rewrite crypto.ts functions as Crypto class and use in init

* feat: update thrown error name in JSDoc of Webhook.authenticate

* test(Crypto): update tests to use new class based instantiation

* refactor(Crypto): change constructor to optional `publicSigningKey`

Instead of `publicKey`, `publicSigningKey` makes it more obvious of what the use of the key is for.
Making constructor optional also allows users of the library to encrypt and decrypt without having to provide a public signing key if they do not want to and still be able to decrypt content without verified fields.

Note that the default package initialisation still instantiates the library with a fallback key.

* refactor: allow optional constructor params

* test(Crypto): add tests for 100% coverage

* refactor: update import order

* test: remove misleading comment

75 of 86 branches covered (87.21%)

Branch coverage included in aggregate %.

66 of 66 new or added lines in 4 files covered. (100.0%)

265 of 269 relevant lines covered (98.51%)

4.27 hits per line