4.2.0 (#51)

* 4.2.0

* docs: add changelog entries

* docs: edit typescript entry

* docs: refactor changelog entries

---------

Co-authored-by: github-actions <[email protected]>
Co-authored-by: Michele Esposito <[email protected]>

CHANGELOG.md

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.2.0]
+### Added
+- Support key derivation options ([#49](https://github.com/MetaMask/browser-passworder/pull/49))
+  - Added `EncryptionKey` type to hold a `CryptoKey` along with its derivation parameters.
+  - Added `ExportedEncryptionKey` type to hold a `JsonWebKey` along with its derivation parameters.
+  - Added Optional `keyMetadata` property of type `KeyDerivationOptions` to `EncryptionResult`.
+  - Added Optional `opts`  argument to `keyFromPassword` to specify algorithm and parameters to be used in the key derivation. Defaults to `PBKDF2` with 900.000 iterations.(https://github.com/MetaMask/browser-passworder/pull/49))
+  - Added `iterations` argument to `keyFromPassword` function.
+  - Added optional `keyDerivationOptions` argument to `encrypt` and `encryptWithDetail` to specify algorithm and parameters to be used in the key Defaults to `PBKDF2` at 900.000 iterations.
+- Added `updateVaultWithDetail` function to update existing vault and exported key with a safer encryption method if available ([#49](https://github.com/MetaMask/browser-passworder/pull/49))
+- Added `updateVault` function to update existing vault string with a safer encryption method if available ([#49](https://github.com/MetaMask/browser-passworder/pull/49))
+
+### Changed
+- Add optional parameters and properties to support custom derivation options ([#49](https://github.com/MetaMask/browser-passworder/pull/49))
+  - `encrypt` method accepts both `EncryptionKey` and `CryptoKey` types as `key` argument.
+  - `encryptWithKey` method accepts both `EncryptionKey` and `CryptoKey` types as `key` argument.
+  - `decrypt` method accepts both `EncryptionKey` and `CryptoKey` types as `key` argument.
+  - `decryptWithKey` method accepts both `EncryptionKey` and `CryptoKey` types as `key` argument.
+  - `importKey` method returns a `CryptoKey` when a JWK string is passed, or an `EncryptionKey` when an `ExportedEncryptionKey` string is passed.
+  - `exportKey` method accepts both `EncryptionKey` and `CryptoKey` types as `key` argument, and returns an `ExportedEncryptionKey` for the former and a `JsonWebKey` for the latter.
+- Pin TypeScript version to `~4.8.4` ([#50](https://github.com/MetaMask/browser-passworder/pull/50))
+
 ## [4.1.0]
 ### Changed
 - Export data types ([#45](https://github.com/MetaMask/browser-passworder/pull/45))
@@ -40,7 +62,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Convert to TypeScript ([#6](https://github.com/MetaMask/browser-passworder/pull/6))
 - Remove `browserify-unibabel` dependency ([#13](https://github.com/MetaMask/browser-passworder/pull/13))
 
-[Unreleased]: https://github.com/MetaMask/browser-passworder/compare/v4.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/browser-passworder/compare/v4.2.0...HEAD
+[4.2.0]: https://github.com/MetaMask/browser-passworder/compare/v4.1.0...v4.2.0
 [4.1.0]: https://github.com/MetaMask/browser-passworder/compare/v4.0.2...v4.1.0
 [4.0.2]: https://github.com/MetaMask/browser-passworder/compare/v4.0.1...v4.0.2
 [4.0.1]: https://github.com/MetaMask/browser-passworder/compare/v4.0.0...v4.0.1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/browser-passworder",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "A simple browserifiable module for password-encrypting JS objects.",
   "keywords": [
     "Browser",