chore(release): v3.0.0 [skip ci]

decentralized-identity · Sep 20, 2021 · 4086ea7 · 4086ea7
1 parent b535d91
commit 4086ea7
Show file tree

Hide file tree

Showing 40 changed files with 496 additions and 74 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,56 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/uport-project/veramo/compare/v2.1.3...v3.0.0) (2021-09-20)
+
+
+### Bug Fixes
+
+* **deps:** update all non-major dependencies ([8fc5312](https://github.com/uport-project/veramo/commit/8fc53120498ce2982e8ec640e00bbb03f6f4204e))
+* **deps:** update builders-and-testers ([acef171](https://github.com/uport-project/veramo/commit/acef171a1845ed4b1022efc5a8cd7a893db4e73a))
+* **deps:** update builders-and-testers ([ca746d2](https://github.com/uport-project/veramo/commit/ca746d2450ca0d08703a219e4f17f3f2966bd0db))
+* **deps:** update dependency @microsoft/api-extractor to v7.18.6 ([80b8f67](https://github.com/uport-project/veramo/commit/80b8f673539c0fa62bc24490d9b09acecbd3e4d1))
+* **deps:** update dependency @microsoft/api-extractor to v7.18.7 ([28d7cf0](https://github.com/uport-project/veramo/commit/28d7cf09afdef1b0905dfbe6520dc953a2da27cd))
+* **deps:** update dependency uint8arrays to v3 ([#669](https://github.com/uport-project/veramo/issues/669)) ([a5f5c42](https://github.com/uport-project/veramo/commit/a5f5c421d307b39d926f2d701ef3b9861c325dea))
+* **did-ethr-provider:** allow initialization with chainId number ([#678](https://github.com/uport-project/veramo/issues/678)) ([38cd0ae](https://github.com/uport-project/veramo/commit/38cd0aeb438ada57eb95464cabe072d02cbebb2b)), closes [#677](https://github.com/uport-project/veramo/issues/677)
+* **did-resolver:** always include didResolutionMetadata in result ([#682](https://github.com/uport-project/veramo/issues/682)) ([aabddb4](https://github.com/uport-project/veramo/commit/aabddb436b8b4dd78378da4704ba00147d074cdb)), closes [#681](https://github.com/uport-project/veramo/issues/681)
+* **key-manager:** handle eth_signTransaction with from field ([#675](https://github.com/uport-project/veramo/issues/675)) ([50f074d](https://github.com/uport-project/veramo/commit/50f074ddcab5dbafe5bad0ebcbfde8a9f91826e4)), closes [#674](https://github.com/uport-project/veramo/issues/674)
+
+
+### Features
+
+* **data-store:** initialize DB using migrations ([#679](https://github.com/uport-project/veramo/issues/679)) ([41f6240](https://github.com/uport-project/veramo/commit/41f6240d68a79338772230cbfff768189ab031ed)), closes [#676](https://github.com/uport-project/veramo/issues/676)
+* **key-manager:** move private key storage to kms-local ([#661](https://github.com/uport-project/veramo/issues/661)) ([6b1d135](https://github.com/uport-project/veramo/commit/6b1d135eedb1c58b715be8941d34312da39facb2)), closes [#539](https://github.com/uport-project/veramo/issues/539) [#540](https://github.com/uport-project/veramo/issues/540) [#680](https://github.com/uport-project/veramo/issues/680)
+
+
+### BREAKING CHANGES
+
+* **key-manager:** `keyManagetGet` no longer returns private key data
+* **key-manager:** `KeyStore` no longer requires a `SecretBox`
+* **key-manager:** `KeyManagementSystem` needs a `PrivateKeyStore`
+* **key-manager:** @veramo/cli configuration version update to 3.0
+
+If you're already working with Veramo and wish to upgrade existing agents to veramo 3.0, you'll have to make some changes to your configuration, depending on how you're using the framework.
+
+It boils down to these 3 steps:
+
+1. Update your database connection to use migrations
+2. Remove the `SecretBox` parameter from `KeyManager`
+3. Add a `PrivateKeyStore` parameter to `KeyManagementSystem` with a `SecretBox` that you were using before with `KeyManager` (and keep the same encryption key)
+
+* feat(key-manager): move private key storage to kms-local
+* **data-store:** database needs migrations for initialization. See #679 #676
+The `@veramo/data-store` package relies on `typeorm` as a database abstraction.
+Typeorm has a connection flag `synchonize` which bootstraps the database along with schema and relations based on a set of `Entities` (annotated typescript classes).
+This is very handy for fast development iterations but it is **not recommended for production** use because there is too much ambiguity possible when the `Entities` change, and there is a risk of data loss.
+The recommended way to do things is to use the `migrations` mechanism. It allows you to migrate to new database schemas when necessary, and even customize the database to your own needs.
+
+**Going forward, this is the mechanism we will be recommending for connections.**
+
+
+
+
+
 ## [2.1.3](https://github.com/uport-project/veramo/compare/v2.1.2...v2.1.3) (2021-09-01)
 
 **Note:** Version bump only for package veramo

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "2.1.3",
+  "version": "3.0.0",
   "packages": [
     "packages/*"
   ],

diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -3,6 +3,51 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/uport-project/veramo/compare/v2.1.3...v3.0.0) (2021-09-20)
+
+
+### Bug Fixes
+
+* **deps:** update builders-and-testers ([acef171](https://github.com/uport-project/veramo/commit/acef171a1845ed4b1022efc5a8cd7a893db4e73a))
+* **deps:** update builders-and-testers ([ca746d2](https://github.com/uport-project/veramo/commit/ca746d2450ca0d08703a219e4f17f3f2966bd0db))
+* **deps:** update dependency @microsoft/api-extractor to v7.18.6 ([80b8f67](https://github.com/uport-project/veramo/commit/80b8f673539c0fa62bc24490d9b09acecbd3e4d1))
+* **deps:** update dependency @microsoft/api-extractor to v7.18.7 ([28d7cf0](https://github.com/uport-project/veramo/commit/28d7cf09afdef1b0905dfbe6520dc953a2da27cd))
+
+
+### Features
+
+* **data-store:** initialize DB using migrations ([#679](https://github.com/uport-project/veramo/issues/679)) ([41f6240](https://github.com/uport-project/veramo/commit/41f6240d68a79338772230cbfff768189ab031ed)), closes [#676](https://github.com/uport-project/veramo/issues/676)
+* **key-manager:** move private key storage to kms-local ([#661](https://github.com/uport-project/veramo/issues/661)) ([6b1d135](https://github.com/uport-project/veramo/commit/6b1d135eedb1c58b715be8941d34312da39facb2)), closes [#539](https://github.com/uport-project/veramo/issues/539) [#540](https://github.com/uport-project/veramo/issues/540) [#680](https://github.com/uport-project/veramo/issues/680)
+
+
+### BREAKING CHANGES
+
+* **key-manager:** `keyManagetGet` no longer returns private key data
+* **key-manager:** `KeyStore` no longer requires a `SecretBox`
+* **key-manager:** `KeyManagementSystem` needs a `PrivateKeyStore`
+* **key-manager:** @veramo/cli configuration version update to 3.0
+
+If you're already working with Veramo and wish to upgrade existing agents to veramo 3.0, you'll have to make some changes to your configuration, depending on how you're using the framework.
+
+It boils down to these 3 steps:
+
+1. Update your database connection to use migrations
+2. Remove the `SecretBox` parameter from `KeyManager`
+3. Add a `PrivateKeyStore` parameter to `KeyManagementSystem` with a `SecretBox` that you were using before with `KeyManager` (and keep the same encryption key)
+
+* feat(key-manager): move private key storage to kms-local
+* **data-store:** database needs migrations for initialization. See #679 #676
+The `@veramo/data-store` package relies on `typeorm` as a database abstraction.
+Typeorm has a connection flag `synchonize` which bootstraps the database along with schema and relations based on a set of `Entities` (annotated typescript classes).
+This is very handy for fast development iterations but it is **not recommended for production** use because there is too much ambiguity possible when the `Entities` change, and there is a risk of data loss.
+The recommended way to do things is to use the `migrations` mechanism. It allows you to migrate to new database schemas when necessary, and even customize the database to your own needs.
+
+**Going forward, this is the mechanism we will be recommending for connections.**
+
+
+
+
+
 ## [2.1.3](https://github.com/uport-project/veramo/compare/v2.1.2...v2.1.3) (2021-09-01)
 
 **Note:** Version bump only for package @veramo/cli

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@veramo/cli",
   "description": "Veramo command line application.",
-  "version": "2.1.3",
+  "version": "3.0.0",
   "main": "build/cli.js",
   "types": "build/cli.d.ts",
   "bin": {
@@ -18,24 +18,24 @@
     "@microsoft/api-extractor-model": "7.13.7",
     "@types/blessed": "^0.1.17",
     "@types/swagger-ui-express": "^4.1.2",
-    "@veramo/core": "^2.1.0",
-    "@veramo/credential-w3c": "^2.1.0",
-    "@veramo/data-store": "^2.1.0",
-    "@veramo/did-comm": "^2.1.3",
-    "@veramo/did-discovery": "^2.1.0",
-    "@veramo/did-jwt": "^2.1.0",
-    "@veramo/did-manager": "^2.1.0",
-    "@veramo/did-provider-ethr": "^2.1.0",
-    "@veramo/did-provider-key": "^2.1.0",
-    "@veramo/did-provider-web": "^2.1.0",
-    "@veramo/did-resolver": "^2.1.0",
-    "@veramo/key-manager": "^2.1.0",
-    "@veramo/kms-local": "^2.1.1",
-    "@veramo/message-handler": "^2.1.0",
-    "@veramo/remote-client": "^2.1.0",
-    "@veramo/remote-server": "^2.1.0",
-    "@veramo/selective-disclosure": "^2.1.0",
-    "@veramo/url-handler": "^2.1.0",
+    "@veramo/core": "^3.0.0",
+    "@veramo/credential-w3c": "^3.0.0",
+    "@veramo/data-store": "^3.0.0",
+    "@veramo/did-comm": "^3.0.0",
+    "@veramo/did-discovery": "^3.0.0",
+    "@veramo/did-jwt": "^3.0.0",
+    "@veramo/did-manager": "^3.0.0",
+    "@veramo/did-provider-ethr": "^3.0.0",
+    "@veramo/did-provider-key": "^3.0.0",
+    "@veramo/did-provider-web": "^3.0.0",
+    "@veramo/did-resolver": "^3.0.0",
+    "@veramo/key-manager": "^3.0.0",
+    "@veramo/kms-local": "^3.0.0",
+    "@veramo/message-handler": "^3.0.0",
+    "@veramo/remote-client": "^3.0.0",
+    "@veramo/remote-server": "^3.0.0",
+    "@veramo/selective-disclosure": "^3.0.0",
+    "@veramo/url-handler": "^3.0.0",
     "blessed": "^0.1.81",
     "commander": "^7.0.0",
     "console-table-printer": "^2.8.2",

diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -3,6 +3,48 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/uport-project/veramo/compare/v2.1.3...v3.0.0) (2021-09-20)
+
+
+### Bug Fixes
+
+* **deps:** update all non-major dependencies ([8fc5312](https://github.com/uport-project/veramo/commit/8fc53120498ce2982e8ec640e00bbb03f6f4204e))
+
+
+### Features
+
+* **data-store:** initialize DB using migrations ([#679](https://github.com/uport-project/veramo/issues/679)) ([41f6240](https://github.com/uport-project/veramo/commit/41f6240d68a79338772230cbfff768189ab031ed)), closes [#676](https://github.com/uport-project/veramo/issues/676)
+* **key-manager:** move private key storage to kms-local ([#661](https://github.com/uport-project/veramo/issues/661)) ([6b1d135](https://github.com/uport-project/veramo/commit/6b1d135eedb1c58b715be8941d34312da39facb2)), closes [#539](https://github.com/uport-project/veramo/issues/539) [#540](https://github.com/uport-project/veramo/issues/540) [#680](https://github.com/uport-project/veramo/issues/680)
+
+
+### BREAKING CHANGES
+
+* **key-manager:** `keyManagetGet` no longer returns private key data
+* **key-manager:** `KeyStore` no longer requires a `SecretBox`
+* **key-manager:** `KeyManagementSystem` needs a `PrivateKeyStore`
+* **key-manager:** @veramo/cli configuration version update to 3.0
+
+If you're already working with Veramo and wish to upgrade existing agents to veramo 3.0, you'll have to make some changes to your configuration, depending on how you're using the framework.
+
+It boils down to these 3 steps:
+
+1. Update your database connection to use migrations
+2. Remove the `SecretBox` parameter from `KeyManager`
+3. Add a `PrivateKeyStore` parameter to `KeyManagementSystem` with a `SecretBox` that you were using before with `KeyManager` (and keep the same encryption key)
+
+* feat(key-manager): move private key storage to kms-local
+* **data-store:** database needs migrations for initialization. See #679 #676
+The `@veramo/data-store` package relies on `typeorm` as a database abstraction.
+Typeorm has a connection flag `synchonize` which bootstraps the database along with schema and relations based on a set of `Entities` (annotated typescript classes).
+This is very handy for fast development iterations but it is **not recommended for production** use because there is too much ambiguity possible when the `Entities` change, and there is a risk of data loss.
+The recommended way to do things is to use the `migrations` mechanism. It allows you to migrate to new database schemas when necessary, and even customize the database to your own needs.
+
+**Going forward, this is the mechanism we will be recommending for connections.**
+
+
+
+
+
 # [2.1.0](https://github.com/uport-project/veramo/compare/v2.0.1...v2.1.0) (2021-08-11)
 
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@veramo/core",
   "description": "Veramo Core Logic & Interfaces.",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {

diff --git a/packages/credential-w3c/CHANGELOG.md b/packages/credential-w3c/CHANGELOG.md
@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/uport-project/veramo/compare/v2.1.3...v3.0.0) (2021-09-20)
+
+
+### Bug Fixes
+
+* **deps:** update all non-major dependencies ([8fc5312](https://github.com/uport-project/veramo/commit/8fc53120498ce2982e8ec640e00bbb03f6f4204e))
+
+
+
+
+
 # [2.1.0](https://github.com/uport-project/veramo/compare/v2.0.1...v2.1.0) (2021-08-11)
 
 

diff --git a/packages/credential-w3c/package.json b/packages/credential-w3c/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@veramo/credential-w3c",
   "description": "Veramo plugin for working with W3C Verifiable Credentials & Presentations.",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -14,10 +14,10 @@
     }
   },
   "dependencies": {
-    "@veramo/core": "^2.1.0",
-    "@veramo/did-jwt": "^2.1.0",
-    "@veramo/did-resolver": "^2.1.0",
-    "@veramo/message-handler": "^2.1.0",
+    "@veramo/core": "^3.0.0",
+    "@veramo/did-jwt": "^3.0.0",
+    "@veramo/did-resolver": "^3.0.0",
+    "@veramo/message-handler": "^3.0.0",
     "blakejs": "^1.1.0",
     "debug": "^4.1.1",
     "did-jwt-vc": "2.1.7",

diff --git a/packages/data-store/CHANGELOG.md b/packages/data-store/CHANGELOG.md
@@ -3,6 +3,43 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/uport-project/veramo/compare/v2.1.3...v3.0.0) (2021-09-20)
+
+
+### Features
+
+* **data-store:** initialize DB using migrations ([#679](https://github.com/uport-project/veramo/issues/679)) ([41f6240](https://github.com/uport-project/veramo/commit/41f6240d68a79338772230cbfff768189ab031ed)), closes [#676](https://github.com/uport-project/veramo/issues/676)
+* **key-manager:** move private key storage to kms-local ([#661](https://github.com/uport-project/veramo/issues/661)) ([6b1d135](https://github.com/uport-project/veramo/commit/6b1d135eedb1c58b715be8941d34312da39facb2)), closes [#539](https://github.com/uport-project/veramo/issues/539) [#540](https://github.com/uport-project/veramo/issues/540) [#680](https://github.com/uport-project/veramo/issues/680)
+
+
+### BREAKING CHANGES
+
+* **key-manager:** `keyManagetGet` no longer returns private key data
+* **key-manager:** `KeyStore` no longer requires a `SecretBox`
+* **key-manager:** `KeyManagementSystem` needs a `PrivateKeyStore`
+* **key-manager:** @veramo/cli configuration version update to 3.0
+
+If you're already working with Veramo and wish to upgrade existing agents to veramo 3.0, you'll have to make some changes to your configuration, depending on how you're using the framework.
+
+It boils down to these 3 steps:
+
+1. Update your database connection to use migrations
+2. Remove the `SecretBox` parameter from `KeyManager`
+3. Add a `PrivateKeyStore` parameter to `KeyManagementSystem` with a `SecretBox` that you were using before with `KeyManager` (and keep the same encryption key)
+
+* feat(key-manager): move private key storage to kms-local
+* **data-store:** database needs migrations for initialization. See #679 #676
+The `@veramo/data-store` package relies on `typeorm` as a database abstraction.
+Typeorm has a connection flag `synchonize` which bootstraps the database along with schema and relations based on a set of `Entities` (annotated typescript classes).
+This is very handy for fast development iterations but it is **not recommended for production** use because there is too much ambiguity possible when the `Entities` change, and there is a risk of data loss.
+The recommended way to do things is to use the `migrations` mechanism. It allows you to migrate to new database schemas when necessary, and even customize the database to your own needs.
+
+**Going forward, this is the mechanism we will be recommending for connections.**
+
+
+
+
+
 # [2.1.0](https://github.com/uport-project/veramo/compare/v2.0.1...v2.1.0) (2021-08-11)
 
 

diff --git a/packages/data-store/package.json b/packages/data-store/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@veramo/data-store",
   "description": "Veramo date storage based on TypeORM",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -14,10 +14,10 @@
     }
   },
   "dependencies": {
-    "@veramo/core": "^2.1.0",
-    "@veramo/did-discovery": "^2.1.0",
-    "@veramo/did-manager": "^2.1.0",
-    "@veramo/key-manager": "^2.1.0",
+    "@veramo/core": "^3.0.0",
+    "@veramo/did-discovery": "^3.0.0",
+    "@veramo/did-manager": "^3.0.0",
+    "@veramo/key-manager": "^3.0.0",
     "debug": "^4.1.1",
     "typeorm": "0.2.37"
   },

diff --git a/packages/did-comm/CHANGELOG.md b/packages/did-comm/CHANGELOG.md
@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0](https://github.com/uport-project/veramo/compare/v2.1.3...v3.0.0) (2021-09-20)
+
+
+### Bug Fixes
+
+* **deps:** update all non-major dependencies ([8fc5312](https://github.com/uport-project/veramo/commit/8fc53120498ce2982e8ec640e00bbb03f6f4204e))
+* **deps:** update dependency uint8arrays to v3 ([#669](https://github.com/uport-project/veramo/issues/669)) ([a5f5c42](https://github.com/uport-project/veramo/commit/a5f5c421d307b39d926f2d701ef3b9861c325dea))
+* **did-resolver:** always include didResolutionMetadata in result ([#682](https://github.com/uport-project/veramo/issues/682)) ([aabddb4](https://github.com/uport-project/veramo/commit/aabddb436b8b4dd78378da4704ba00147d074cdb)), closes [#681](https://github.com/uport-project/veramo/issues/681)
+
+
+### Features
+
+* **data-store:** initialize DB using migrations ([#679](https://github.com/uport-project/veramo/issues/679)) ([41f6240](https://github.com/uport-project/veramo/commit/41f6240d68a79338772230cbfff768189ab031ed)), closes [#676](https://github.com/uport-project/veramo/issues/676)
+
+
+### BREAKING CHANGES
+
+* **data-store:** database needs migrations for initialization. See #679 #676
+The `@veramo/data-store` package relies on `typeorm` as a database abstraction.
+Typeorm has a connection flag `synchonize` which bootstraps the database along with schema and relations based on a set of `Entities` (annotated typescript classes).
+This is very handy for fast development iterations but it is **not recommended for production** use because there is too much ambiguity possible when the `Entities` change, and there is a risk of data loss.
+The recommended way to do things is to use the `migrations` mechanism. It allows you to migrate to new database schemas when necessary, and even customize the database to your own needs.
+
+**Going forward, this is the mechanism we will be recommending for connections.**
+
+
+
+
+
 ## [2.1.3](https://github.com/uport-project/veramo/compare/v2.1.2...v2.1.3) (2021-09-01)
 
 **Note:** Version bump only for package @veramo/did-comm