All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.
6.0.0 (2024-04-02)
- The
plugin.schema.json
files are now generated asplugin.schema.ts
.
5.6.0 (2024-01-16)
- remote-client: allow dynamic headers param for AgentRestClient constructor (#1314) (1b8a0a2), closes #1313
5.5.3 (2023-10-09)
5.5.2 (2023-10-06)
- data-store: match claims by credential hash when deleting credential (#1270) (4ee626d), closes #1269
5.5.1 (2023-09-21)
5.5.0 (2023-09-19)
- data-store: order skip take in orm and json (#1243) (28c1224)
- did-provider-key: use compressed keys for creating Secp256k1 did:key (#1217) (ba8f6f5), closes #1213
5.4.1 (2023-08-04)
5.4.0 (2023-08-01)
5.3.0 (2023-07-27)
Note: Version bump only for package @veramo/data-store
5.2.0 (2023-05-02)
5.1.2 (2023-02-25)
Note: Version bump only for package @veramo/data-store
5.1.0 (2023-02-24)
5.0.0 (2023-02-09)
- did-manager: rename AbstractDIDStore methods for SES compatibility (0287340), closes #1090
- key-manager: rename Abstract[Private]KeyStore methods for SES compatibility (91631b6), closes #1090
- did-manager: implementations of AbstractDIDStore need to rename their methods to conform to the new API. Functionality remains the same.
- key-manager: implementations of AbstractKeyStore and AbstractPrivateKeyStore need to rename their methods to conform to the new API. Functionality remains the same.
- this is a breaking change as modules will have to be imported differently:
- https://www.typescriptlang.org/docs/handbook/esm-node.html
- https://nodejs.org/api/esm.html
- https://caniuse.com/?search=modules
test(did-provider-ion): skip a couple of tests that fail with unreasonable errors chore: use ubuntu-latest on CI fix: temporarily remove puppeteer tests fix: use craco for test-react-app to enable babel config test: fix unit and integration tests (browser tests still broken) fix: fix some build issues that prevented tests from working fix: missing deps flagged by pnpm
4.3.0 (2023-01-27)
Note: Version bump only for package @veramo/data-store
4.2.0 (2022-12-05)
- credential-ld: simplify signature suite use of Uint8Array (49a10ec)
- deps: bump dependencies (701b8ed)
4.1.1 (2022-11-01)
Note: Version bump only for package @veramo/data-store
4.1.0 (2022-10-31)
Note: Version bump only for package @veramo/data-store
4.0.2 (2022-10-04)
4.0.0 (2022-09-22)
- deps: update all non-major dependencies (a7a5b5d)
- deps: update all non-major dependencies (04c0053)
- deps: update all non-major dependencies (d8aa16a)
- deps: update all non-major dependencies (183b4bc)
- deps: update dependency typeorm to v0.2.41 (61a8103)
- did-resolver: use interface
Resolvable
instead of theResolver
class (9c2e59f) - docs: fix relevant errors and warnings in TSDoc to enable proper docs generation on
[@next](https://github.com/next)
branch (79c3872) - update and fix inline documentation of all exported types (#921) (63e64e0)
- add partial match for dids and aliases in did discovery provider for data store (92b793e)
- add support for serviceEndpoint property as defined in latest DID Spec (#988) (9bed70b)
- credential-ld: add support for browser environments (#916) (435e4d2)
- credential-w3c: add ICredentialPlugin interface in core package (#1001) (7b6d195), closes #941
- data-store: use DataSource instead of Connection (#970) (3377930), closes #947
- date-store-json: add JSON object storage implementation (#819) (934b34a)
- update did-discover-provider to search by DID likeness in addition to name (3696a7a)
- the
did-resolver
and connected libraries change the data-type forServiceEndpoint
toService
and the previous semantic has changed. Services can have multiple endpoints, not just a single string.
3.1.4 (2022-06-02)
3.1.3 (2022-06-01)
Note: Version bump only for package @veramo/data-store
3.1.0 (2021-11-12)
- data-store: add support for entityPrefix (#725) (801bb95), closes #724
- deps: update all non-major dependencies (a6614e8)
3.0.0 (2021-09-20)
- data-store: initialize DB using migrations (#679) (41f6240), closes #676
- key-manager: move private key storage to kms-local (#661) (6b1d135), closes #539 #540 #680
- key-manager:
keyManagetGet
no longer returns private key data - key-manager:
KeyStore
no longer requires aSecretBox
- key-manager:
KeyManagementSystem
needs aPrivateKeyStore
- 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:
- Update your database connection to use migrations
- Remove the
SecretBox
parameter fromKeyManager
- Add a
PrivateKeyStore
parameter toKeyManagementSystem
with aSecretBox
that you were using before withKeyManager
(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 ontypeorm
as a database abstraction. Typeorm has a connection flagsynchonize
which bootstraps the database along with schema and relations based on a set ofEntities
(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 theEntities
change, and there is a risk of data loss. The recommended way to do things is to use themigrations
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 (2021-08-11)
- credentials-w3c: accept Presentations without Credentials (#616) (2389cd0)
- dataStoreDeleteVerifiableCredential (#652) (840d89b), closes #649
2.0.0 (2021-07-14)
- did-discovery: implement a DID discovery plugin with simple providers (#597) (6f01df3)
- key-manager: add generic signing capabilities (#529) (5f10a1b), closes #522
- kms-local:
@veramo/kms-local-react-native
is no more. On react-native, please use@veramo/kms-local
instead, combined with@ethersproject/shims
1.2.0 (2021-04-27)
Note: Version bump only for package @veramo/data-store
1.1.2 (2021-04-26)
1.1.0 (2021-01-26)
Note: Version bump only for package @veramo/data-store