hyperledger-identus / sdk-ts / 23341775543

76%

push

github

fix!: v8 refactor + deprecations (#511)

Signed-off-by: Francisco Javier Ribo Labrador <elribonazo@gmail.com>
Signed-off-by: Allain Magyar <allain.magyar@iohk.io>
Co-authored-by: Allain Magyar <allain.magyar@iohk.io>

BREAKING CHANCES:
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.

### Future deprecation notice
The following items have been marked as deprecated and will be removed in a future version of the SDK, but are still available.

- CreatePrismDID and CreatePrismDIDArgs from @hyperledger/identus-sdk, can still be used but is deprecated. We are introducing a new simplified function CreatePrismDIDWithKeys and type CreatePrismDIDWithKeysArgs from @hyperledger/identus-sdk


### Deprecated exports
- No more default export in @hyperledger/identus-sdk.

```typescript
// 7.x
import SDK from "@hyperledger/identus-sdk";

// 8.x
import * as SDK from "@hyperledger/identus-sdk";
```

- CreateOOBOffer and CreateOOBOfferArgs from @hyperledger/identus-sdk.

```typescript
// 7.x
import { CreateOOBOffer, type CreateOOBOfferArgs } from "@hyperledger/identus-sdk";

// 8.x
import { CreateOOBOffer, type CreateOOBOfferArgs } from "@hyperledger/identus-sdk/plugins/didcomm";
```

- RunProtocol and RunProtocolArgs from @hyperledger/identus-sdk

The RunProtocol becomes internal as its only managed by the SDK internals, the functionality is exposed through the Agent class.

Internally ```agent.handle``` uses the RunProtocol task to run the protocol, message is of type ```Domain.Message```.

```typescript
agent.handle(message)
```

- CreateOOBPresentationRequest and CreateOOBPresentationRequestArgs from @hyperledger/identus-sdk.

```typescript
// 7.x
import { CreateOOBPresentationRequest, type CreateOOBPresentationRequestArgs } from "@hyperledger/identus-sdk";

// 8.x
import { CreateOOBPresentationRequest, type CreateOOBPresentationRequestA... (continued)

1344 of 1972 branches covered (68.15%)

Branch coverage included in aggregate %.

297 of 401 new or added lines in 61 files covered. (74.06%)

2992 of 3788 relevant lines covered (78.99%)

48.28 hits per line