Skip to content

Commit a4a9d0b

Browse files
authored
fix: improve documentation (#453)
Signed-off-by: Francisco Javier Ribo Labrador <elribonazo@gmail.com>
1 parent 0aaf408 commit a4a9d0b

File tree

89 files changed

+1569
-424
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+1569
-424
lines changed

docs/migration/migrating_6x_to_7x.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Migration guide from 6.X to 7.X
2+
This migration guide applies to both @hyperledger/identus-edge-agent-sdk and @hyperledger/identus-sdk.
3+
4+
## Breaking Changes
5+
If core internals where not in use, this breaking changes are likely to not affect you, except if you weren't relying on the Agent but using the internals directly for some things.
6+
7+
### 1. Anoncreds, DIDComm, OEA and DIF no longer exported in core bundle.
8+
For most cases all functionality is still available through plugins.
9+
10+
```typescript
11+
import {OEA} from '@hyperledger/identus-sdk/plugins/oea';
12+
import * as DIDComm from '@hyperledger/identus-sdk/plugins/didcomm'
13+
import {DIF} from '@hyperledger/identus-sdk/plugins/dif'
14+
import * as Anoncreds from '@hyperledger/identus-sdk/plugins/anoncreds'
15+
```
16+
17+
If there's other functionality that you can no longer find in the plugins please let us now and open an issue.
18+
19+
### 2. Revocation no longer handled automatically, Revocation message now needs to be passed to agent.handle function.
20+
21+
On version 6.X If you would receive a Credential Revocation message we would automatically update the Credential for you, updating revoked to true. That is no longer like that.
22+
23+
```typescript
24+
agent.addEventListener(ListenerKeys.Message, async (messages) => {
25+
const revokations = messages.filter(({piuri}) => piuri === SDK.ProtocolType.PrismRevocation);
26+
for (let revocation of revocations) {
27+
await agent.handle(revocation)
28+
}
29+
})
30+
```
31+

docs/sidebars.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,18 @@ const sidebars = {
139139
type: 'doc',
140140
id: 'decisions/sdk-package-release',
141141
}
142-
143142
]
144143
},
144+
{
145+
type: 'category',
146+
label: 'Migration',
147+
items: [
148+
{
149+
type: 'doc',
150+
id: 'migration/migrating_6x_to_7x'
151+
}
152+
]
153+
}
145154
]
146155
}
147156

index.cjs

Lines changed: 0 additions & 6 deletions
This file was deleted.

index.d.ts

Lines changed: 0 additions & 2 deletions
This file was deleted.

index.mjs

Lines changed: 0 additions & 3 deletions
This file was deleted.

integration-tests/node/cjs/package-lock.json

Lines changed: 92 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration-tests/node/esm/package-lock.json

Lines changed: 92 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration-tests/node/ts-cjs/package-lock.json

Lines changed: 88 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)